io

Documentation

Overview

package unixfs/io implements convenience objects for working with the ipfs unixfs data format.

Index

• Variables
• func NewBufDagReader(b []byte) *bufDagReader
• func NewDirectory(dserv mdag.DAGService) *directoryBuilder
• func NewEmptyDirectory() *mdag.ProtoNode
• func NewPBFileReader(ctx context.Context, n *mdag.ProtoNode, pb *ftpb.Data, serv mdag.DAGService) *pbDagReader
• func ResolveUnixfsOnce(ctx context.Context, ds dag.DAGService, nd node.Node, name string) (*node.Link, error)
• type DagReader
  • func NewDagReader(ctx context.Context, n node.Node, serv mdag.DAGService) (DagReader, error)
• type ReadSeekCloser

Variables

var ErrCantReadSymlinks = errors.New("cannot currently read symlinks")

var ErrIsDir = errors.New("this dag node is a directory")

Functions

func NewBufDagReader

func NewBufDagReader(b []byte) *bufDagReader

func NewDirectory

func NewDirectory(dserv mdag.DAGService) *directoryBuilder

NewDirectory returns a directoryBuilder. It needs a DAGService to add the Children

func NewEmptyDirectory

func NewEmptyDirectory() *mdag.ProtoNode

NewEmptyDirectory returns an empty merkledag Node with a folder Data chunk

func NewPBFileReader

func NewPBFileReader(ctx context.Context, n *mdag.ProtoNode, pb *ftpb.Data, serv mdag.DAGService) *pbDagReader

func ResolveUnixfsOnce

func ResolveUnixfsOnce(ctx context.Context, ds dag.DAGService, nd node.Node, name string) (*node.Link, error)

Types

type DagReader

type DagReader interface {
	ReadSeekCloser
	Size() uint64
	CtxReadFull(context.Context, []byte) (int, error)
	Offset() int64
}

func NewDagReader

func NewDagReader(ctx context.Context, n node.Node, serv mdag.DAGService) (DagReader, error)

NewDagReader creates a new reader object that reads the data represented by the given node, using the passed in DAGService for data retreival

type ReadSeekCloser

type ReadSeekCloser interface {
	io.Reader
	io.Seeker
	io.Closer
	io.WriterTo
}