io

Documentation

Overview

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

Index

• Variables
• func NewDirectory(dserv mdag.DAGService) *directoryBuilder
• func NewEmptyDirectory() *mdag.Node
• type DagReader
  • func NewDagReader(ctx context.Context, n *mdag.Node, serv mdag.DAGService) (*DagReader, error)
  • func NewDataFileReader(ctx context.Context, n *mdag.Node, pb *ftpb.Data, serv mdag.DAGService) *DagReader
  • func (dr *DagReader) Close() error
  • func (dr *DagReader) CtxReadFull(ctx context.Context, b []byte) (int, error)
  • func (dr *DagReader) Read(b []byte) (int, error)
  • func (dr *DagReader) Seek(offset int64, whence int) (int64, error)
  • func (dr *DagReader) Size() uint64
  • func (dr *DagReader) WriteTo(w io.Writer) (int64, error)
• type ReadSeekCloser
  • func NewRSNCFromBytes(b []byte) ReadSeekCloser

Variables

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

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

Functions

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.Node

NewEmptyDirectory returns an empty merkledag Node with a folder Data chunk

Types

type DagReader

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

DagReader provides a way to easily read the data contained in a dag.

func NewDagReader

func NewDagReader(ctx context.Context, n *mdag.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

func NewDataFileReader

func NewDataFileReader(ctx context.Context, n *mdag.Node, pb *ftpb.Data, serv mdag.DAGService) *DagReader

func (*DagReader) Close

func (dr *DagReader) Close() error

func (*DagReader) CtxReadFull

func (dr *DagReader) CtxReadFull(ctx context.Context, b []byte) (int, error)

CtxReadFull reads data from the DAG structured file

func (*DagReader) Read

func (dr *DagReader) Read(b []byte) (int, error)

Read reads data from the DAG structured file

func (*DagReader) Seek

func (dr *DagReader) Seek(offset int64, whence int) (int64, error)

Seek implements io.Seeker, and will seek to a given offset in the file interface matches standard unix seek TODO: check if we can do relative seeks, to reduce the amount of dagreader recreations that need to happen.

func (*DagReader) Size

func (dr *DagReader) Size() uint64

Size return the total length of the data from the DAG structured file.

func (*DagReader) WriteTo

func (dr *DagReader) WriteTo(w io.Writer) (int64, error)

type ReadSeekCloser

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

func NewRSNCFromBytes

func NewRSNCFromBytes(b []byte) ReadSeekCloser