file

package

v0.0.0-...-cd21dfb Latest Latest Go to latest Published: Aug 21, 2023 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Conflux-Chain/neurahive-client

Documentation ¶

Index ¶

Constants
Variables
func Exists(name string) (bool, error)
type Downloader
- func NewDownloader(clients ...*node.Client) *Downloader
- func (downloader *Downloader) Download(root, filename string, proof bool) error
type File
- func Open(name string) (*File, error)
- func (file *File) Close() error
- func (file *File) Iterate(flowPadding bool) *Iterator
- func (file *File) MerkleTree() (*merkle.Tree, error)
- func (file *File) NumChunks() uint64
- func (file *File) NumSegments() uint64
type Flow
- func NewFlow(file *File, tags []byte) *Flow
- func (flow *Flow) CreateSubmission() (*contract.Submission, error)
type Iterator
- func NewIterator(file *os.File, fileSize int64, offset int64, batch int64, flowPadding bool) *Iterator
- func NewSegmentIterator(file *os.File, fileSize int64, offset int64, flowPadding bool) *Iterator
- func (it *Iterator) Current() []byte
- func (it *Iterator) Next() (bool, error)
type SegmentDownloader
- func NewSegmentDownloader(clients []*node.Client, file *download.DownloadingFile, withProof bool) (*SegmentDownloader, error)
- func (downloader *SegmentDownloader) Download() error
- func (downloader *SegmentDownloader) ParallelCollect(result *parallel.Result) error
- func (downloader *SegmentDownloader) ParallelDo(routine, task int) (interface{}, error)
type UploadOption
type Uploader
- func NewUploader(flow *contract.FlowContract, client *node.Client) *Uploader
- func NewUploaderLight(client *node.Client) *Uploader
- func (uploader *Uploader) Upload(filename string, option ...UploadOption) error

Constants ¶

View Source

const (
	// DefaultChunkSize represents the default chunk size in bytes.
	DefaultChunkSize = 256

	// DefaultSegmentMaxChunks represents the default maximum number of chunks within a segment.
	DefaultSegmentMaxChunks = 1024

	// DefaultSegmentSize represents the default segment size in bytes.
	DefaultSegmentSize = DefaultChunkSize * DefaultSegmentMaxChunks
)

Variables ¶

View Source

var (
	EmptyChunk     = make([]byte, DefaultChunkSize)
	EmptyChunkHash = crypto.Keccak256Hash(EmptyChunk)
)

View Source

var (
	// ErrFileRequired is returned when manipulate on a folder.
	ErrFileRequired = errors.New("file required")

	// ErrFileEmpty is returned when empty file opened.
	ErrFileEmpty = errors.New("file is empty")
)

Functions ¶

func Exists ¶

func Exists(name string) (bool, error)

Types ¶

type Downloader ¶

type Downloader struct {
	// contains filtered or unexported fields
}

func NewDownloader ¶

func NewDownloader(clients ...*node.Client) *Downloader

func (*Downloader) Download ¶

func (downloader *Downloader) Download(root, filename string, proof bool) error

type File ¶

type File struct {
	os.FileInfo
	// contains filtered or unexported fields
}

func Open ¶

func Open(name string) (*File, error)

func (*File) Close ¶

func (file *File) Close() error

func (*File) Iterate ¶

func (file *File) Iterate(flowPadding bool) *Iterator

func (*File) MerkleTree ¶

func (file *File) MerkleTree() (*merkle.Tree, error)

func (*File) NumChunks ¶

func (file *File) NumChunks() uint64

func (*File) NumSegments ¶

func (file *File) NumSegments() uint64

type Flow ¶

type Flow struct {
	// contains filtered or unexported fields
}

func NewFlow ¶

func NewFlow(file *File, tags []byte) *Flow

func (*Flow) CreateSubmission ¶

func (flow *Flow) CreateSubmission() (*contract.Submission, error)

type Iterator ¶

type Iterator struct {
	// contains filtered or unexported fields
}

func NewIterator ¶

func NewIterator(file *os.File, fileSize int64, offset int64, batch int64, flowPadding bool) *Iterator

func NewSegmentIterator ¶

func NewSegmentIterator(file *os.File, fileSize int64, offset int64, flowPadding bool) *Iterator

func (*Iterator) Current ¶

func (it *Iterator) Current() []byte

func (*Iterator) Next ¶

func (it *Iterator) Next() (bool, error)

type SegmentDownloader ¶

type SegmentDownloader struct {
	// contains filtered or unexported fields
}

func NewSegmentDownloader ¶

func NewSegmentDownloader(clients []*node.Client, file *download.DownloadingFile, withProof bool) (*SegmentDownloader, error)

func (*SegmentDownloader) Download ¶

func (downloader *SegmentDownloader) Download() error

Download downloads segments in parallel.

func (*SegmentDownloader) ParallelCollect ¶

func (downloader *SegmentDownloader) ParallelCollect(result *parallel.Result) error

ParallelCollect implements the parallel.Interface interface.

func (*SegmentDownloader) ParallelDo ¶

func (downloader *SegmentDownloader) ParallelDo(routine, task int) (interface{}, error)

ParallelDo implements the parallel.Interface interface.

type UploadOption ¶

type UploadOption struct {
	Tags  []byte // for kv operations
	Force bool   // for kv to upload same file
}

type Uploader ¶

type Uploader struct {
	// contains filtered or unexported fields
}

func NewUploader ¶

func NewUploader(flow *contract.FlowContract, client *node.Client) *Uploader

func NewUploaderLight ¶

func NewUploaderLight(client *node.Client) *Uploader

func (*Uploader) Upload ¶

func (uploader *Uploader) Upload(filename string, option ...UploadOption) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
download
merkle

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL