unixfile

package

v0.6.1 Latest Latest Go to latest Published: Jan 21, 2021 License: MIT Imports: 19 Imported by: 1

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/TRON-US/go-unixfs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GetRsNode(l interface{}) (uio.Node, error)
func InitDag(ctx context.Context, dataBuf *bytes.Buffer, cid string) context.Context
func NewReedSolomonDirectory(ctx context.Context, root ipld.Node, dataNode ipld.Node, dserv ipld.DAGService, ...) (files.Node, error)
func NewReedSolomonFileUnderDirectory(ctx context.Context, dserv ipld.DAGService, cid string, nd uio.Node, bfs bool) (files.Node, error)
func NewReedSolomonStandaloneFile(ctx context.Context, root ipld.Node, dataNode ipld.Node, dserv ipld.DAGService, ...) (files.Node, error)
func NewReedSolomonSubDirectory(ctx context.Context, dserv ipld.DAGService, cid string, nd uio.Node) (files.Node, error)
func NewUnixfsFile(ctx context.Context, dserv ipld.DAGService, nd ipld.Node, ...) (files.Node, error)
type MetadataStruct
- func ObtainMetadataFromDag(ctx context.Context, metaNode ipld.Node, dserv ipld.NodeGetter) (*MetadataStruct, error)
type ReedSolomonDag
- func GetDag(ctx context.Context, cid string) *ReedSolomonDag
- func NewReedSolomonDag(dataBuf *bytes.Buffer, cid string) *ReedSolomonDag
type RsDirectory
type RsIterator
type UnixfsFileOptions

Constants ¶

View Source

const (
	ReedSolomonDagOff   = 0
	ReedSolomonDagOpen  = 1
	ReedSolomonDagNext  = 2
	ReedSolomonDagClose = 3
)

Variables ¶

View Source

var (
	ErrNilTreeBuf = errors.New("treeBuf is nil for directory node")
)

Functions ¶

func GetRsNode ¶ added in v0.5.2

func GetRsNode(l interface{}) (uio.Node, error)

func InitDag ¶ added in v0.5.2

func InitDag(ctx context.Context, dataBuf *bytes.Buffer, cid string) context.Context

func NewReedSolomonDirectory ¶ added in v0.5.2

func NewReedSolomonDirectory(ctx context.Context, root ipld.Node, dataNode ipld.Node, dserv ipld.DAGService, opts UnixfsFileOptions,
	metaStruct *MetadataStruct) (files.Node, error)

NewReedSolomonDirectory returns files.Node for the root DAG node of a BTFS object in Reed-Solomon encoding. This builder function is supposed to be called only one time for `btfs get` for a BTFS merkle DAG.

func NewReedSolomonFileUnderDirectory ¶ added in v0.5.2

func NewReedSolomonFileUnderDirectory(
	ctx context.Context, dserv ipld.DAGService, cid string, nd uio.Node, bfs bool) (files.Node, error)

NewReedSolomonFileUnderDirectory returns a files.Node for the given `nd` Node. This functioon is called within the context of Reed-Solomon DAG for directory. The given `nd` is a uio.FileNode and is used to create a reader.

func NewReedSolomonStandaloneFile ¶ added in v0.5.2

func NewReedSolomonStandaloneFile(ctx context.Context, root ipld.Node, dataNode ipld.Node, dserv ipld.DAGService, opts UnixfsFileOptions,
	metaStruct *MetadataStruct) (files.Node, error)

func NewReedSolomonSubDirectory ¶ added in v0.5.2

func NewReedSolomonSubDirectory(ctx context.Context, dserv ipld.DAGService, cid string, nd uio.Node) (files.Node, error)

NewReedSolomonSugDirectory creates and returns a files.Dir with the given uio.Node.

func NewUnixfsFile ¶

func NewUnixfsFile(ctx context.Context, dserv ipld.DAGService, nd ipld.Node,
	opts UnixfsFileOptions) (files.Node, error)

NewUnixFsFile returns a DagReader for the 'nd' root node. If opts.Meta = true, only return a valid metadata node if it exists. If not, return error. If opts.Meta = false, return only the data contents. If opts.Meta = false && opts.RepairShards != nil, the shards would be reconstructed and added on this node.

Types ¶

type MetadataStruct ¶ added in v0.5.2

type MetadataStruct struct {
	Buff    []byte
	RsMeta  *chunker.RsMetaMap
	DirRoot *uio.DirNode
}

func ObtainMetadataFromDag ¶ added in v0.5.2

func ObtainMetadataFromDag(ctx context.Context, metaNode ipld.Node, dserv ipld.NodeGetter) (*MetadataStruct, error)

ObtainMetadataFromDag returns MetadataStruct object.

type ReedSolomonDag ¶ added in v0.5.2

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

func GetDag ¶ added in v0.5.2

func GetDag(ctx context.Context, cid string) *ReedSolomonDag

func NewReedSolomonDag ¶ added in v0.5.2

func NewReedSolomonDag(dataBuf *bytes.Buffer, cid string) *ReedSolomonDag

type RsDirectory ¶ added in v0.6.1

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

func (*RsDirectory) Close ¶ added in v0.6.1

func (d *RsDirectory) Close() error

func (*RsDirectory) Entries ¶ added in v0.6.1

func (d *RsDirectory) Entries() files.DirIterator

func (*RsDirectory) IsReedSolomon ¶ added in v0.6.1

func (f *RsDirectory) IsReedSolomon() bool

func (*RsDirectory) SetSize ¶ added in v0.6.1

func (f *RsDirectory) SetSize(size int64) error

func (*RsDirectory) Size ¶ added in v0.6.1

func (d *RsDirectory) Size() (int64, error)

type RsIterator ¶ added in v0.6.1

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

func (*RsIterator) BreadthFirstTraversal ¶ added in v0.6.1

func (it *RsIterator) BreadthFirstTraversal()

func (*RsIterator) Err ¶ added in v0.6.1

func (it *RsIterator) Err() error

func (*RsIterator) Name ¶ added in v0.6.1

func (it *RsIterator) Name() string

func (*RsIterator) Next ¶ added in v0.6.1

func (it *RsIterator) Next() bool

func (*RsIterator) Node ¶ added in v0.6.1

func (it *RsIterator) Node() files.Node

type UnixfsFileOptions ¶ added in v0.5.1

type UnixfsFileOptions struct {
	Meta         bool
	RepairShards []cid.Cid
}

Source Files ¶

View all Source files

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