The highest tagged major version is
Documentation
¶
Overview ¶
Package file provides interfaces for file-oriented operations.
Index ¶
- Variables
- func GenerateSpanSizes(levels, branches int) []int64
- func JoinReadAll(ctx context.Context, j JoinSeeker, addr swarm.Address, outFile io.Writer) (int64, error)
- func Levels(length int64, sectionSize, branches int) int
- func NewAbortError(err error) error
- func NewChunkPipe() io.ReadWriteCloser
- func NewHashError(err error) error
- func NewSimpleReadCloser(buffer []byte) io.ReadCloser
- func SplitWriteAll(ctx context.Context, s Splitter, r io.Reader, l int64, toEncrypt bool) (swarm.Address, error)
- type AbortError
- type ChunkPipe
- type HashError
- type JoinSeeker
- type Splitter
Constants ¶
This section is empty.
Variables ¶
var Spans []int64
Functions ¶
func GenerateSpanSizes ¶
GenerateSpanSizes generates a dictionary of maximum span lengths per level represented by one SectionSize() of data
func JoinReadAll ¶
func JoinReadAll(ctx context.Context, j JoinSeeker, addr swarm.Address, outFile io.Writer) (int64, error)
JoinReadAll reads all output from the provided SeekJoiner.
func Levels ¶
Levels calculates the last level index which a particular data section count will result in. The returned level will be the level of the root hash.
func NewAbortError ¶
NewAbortError creates a new AbortError instance.
func NewHashError ¶
NewHashError creates a new HashError instance.
func NewSimpleReadCloser ¶
func NewSimpleReadCloser(buffer []byte) io.ReadCloser
NewSimpleReadCloser creates a new simpleReadCloser.
Types ¶
type AbortError ¶
type AbortError struct {
// contains filtered or unexported fields
}
AbortError should be returned whenever a file operation is terminated before it has completed.
func (*AbortError) Error ¶
func (e *AbortError) Error() string
Error implements standard go error interface.
type ChunkPipe ¶
type ChunkPipe struct {
io.ReadCloser
// contains filtered or unexported fields
}
ChunkPipe ensures that only the last read is smaller than the chunk size, regardless of size of individual writes.
type HashError ¶
type HashError struct {
// contains filtered or unexported fields
}
HashError should be returned whenever a file operation is terminated before it has completed.
type JoinSeeker ¶ added in v0.2.0
type JoinSeeker interface {
Join(ctx context.Context, address swarm.Address) (dataOut io.ReadSeeker, dataLength int64, err error)
Size(ctx context.Context, address swarm.Address) (dataLength int64, err error)
}
JoinSeeker provides a Joiner that can seek.
type Splitter ¶
type Splitter interface {
Split(ctx context.Context, dataIn io.ReadCloser, dataLength int64, toEncrypt bool) (addr swarm.Address, err error)
}
Splitter starts a new file splitting job.
Data is read from the provided reader. If the dataLength parameter is 0, data is read until io.EOF is encountered. When EOF is received and splitting is done, the resulting Swarm Address is returned.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package pipeline provides functionality for hashing pipelines needed to create different flavors of merkelised representations of arbitrary data.
|
Package pipeline provides functionality for hashing pipelines needed to create different flavors of merkelised representations of arbitrary data. |
|
Package joiner provides implementations of the file.Joiner interface
|
Package joiner provides implementations of the file.Joiner interface |
|
Package splitter provides implementations of the file.Splitter interface
|
Package splitter provides implementations of the file.Splitter interface |