unixfs

package

v1.0.3 Latest Latest Go to latest Published: Mar 31, 2021 License: AGPL-3.0 Imports: 12 Imported by: 0

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

View Source

const (
	ObjectsPath = "objects"
	RefsPath    = "refs"
	InfoPath    = "info"
	PackPath    = "pack"
)

This section is empty.

This section is empty.

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

Unixfs is used to read and write to a unixfs directory.

func Load(ctx context.Context, ds ipld.DAGService, id cid.Cid) (*Unixfs, error)

Load returns an existing unixfs using the directory with the given id.

func New(ctx context.Context, ds ipld.DAGService) (*Unixfs, error)

New returns a new unixfs directory initialized with empty directories.

func (fs *Unixfs) Find(fpath string) (ipld.Node, error)

Find returns the node at the given path.

func (fs *Unixfs) Module() (*Unixfs, error)

Module returns a new unixfs for a submodule

func (fs *Unixfs) Node() (ipld.Node, error)

Save writes the final unixfs to the dag service.

func (fs *Unixfs) Read(fpath string) (io.ReadCloser, error)

Read returns a reader for the file at the given path.

func (fs *Unixfs) Remove(fpath string) error

Remove removes the node at the given path.

func (fs *Unixfs) Walk(fpath string, cb WalkFun) error

Walk walks the directory at the given path and invokes the callback for each entry.

func (fs *Unixfs) Write(fpath string, r io.Reader) error

Write writes the contents of the given reader to the path.

type WalkFun func(string, *ufs.FSNode) error

WalkFun is called for each directory entry.