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
• type DagModifier
  • func NewDagModifier(from *mdag.Node, serv mdag.DAGService, spl chunk.BlockSplitter) (*DagModifier, error)
  • func (dm *DagModifier) GetNode() (*mdag.Node, error)
  • func (dm *DagModifier) Size() uint64
  • func (dm *DagModifier) WriteAt(b []byte, offset uint64) (int, error)
• type DagReader
  • func NewDagReader(ctx context.Context, n *mdag.Node, serv mdag.DAGService) (*DagReader, error)
  • func (dr *DagReader) Close() error
  • func (dr *DagReader) Read(b []byte) (int, error)
  • func (dr *DagReader) Seek(offset int64, whence int) (int64, error)
  • func (dr *DagReader) Size() int64
  • func (dr *DagReader) WriteTo(w io.Writer) (int64, error)
• type ReadSeekCloser
  • func NewRSNCFromBytes(b []byte) ReadSeekCloser

Variables

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

Functions

func NewDirectory

func NewDirectory(dserv mdag.DAGService) *directoryBuilder

Types

type DagModifier

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

DagModifier is the only struct licensed and able to correctly perform surgery on a DAG 'file' Dear god, please rename this to something more pleasant

func NewDagModifier

func NewDagModifier(from *mdag.Node, serv mdag.DAGService, spl chunk.BlockSplitter) (*DagModifier, error)

func (*DagModifier) GetNode

func (dm *DagModifier) GetNode() (*mdag.Node, error)

GetNode gets the modified DAG Node

func (*DagModifier) Size

func (dm *DagModifier) Size() uint64

func (*DagModifier) WriteAt

func (dm *DagModifier) WriteAt(b []byte, offset uint64) (int, error)

WriteAt will modify a dag file in place NOTE: it currently assumes only a single level of indirection

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 (*DagReader) Close

func (dr *DagReader) Close() error

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() int64

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