unixfile

Documentation

Index

• Constants
• 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) (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 UnixfsFileOptions

Constants

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

Functions

func GetRsNode

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

func InitDag

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

func NewReedSolomonDirectory

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

func NewReedSolomonFileUnderDirectory(ctx context.Context, dserv ipld.DAGService, cid string, nd uio.Node) (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

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

func NewReedSolomonSubDirectory

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

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

func ObtainMetadataFromDag

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

ObtainMetadataFromDag returns MetadataStruct object.

type ReedSolomonDag

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

func GetDag

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

func NewReedSolomonDag

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

type UnixfsFileOptions

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