iface

Documentation

Index

• Variables
• type CoreAPI
• type Link
• type Node
• type Path
• type Reader
• type UnixfsAPI

Variables

var ErrIsDir = errors.New("object is a directory")

var ErrOffline = errors.New("can't resolve, ipfs node is offline")

Types

type CoreAPI

type CoreAPI interface {
	Unixfs() UnixfsAPI
	ResolvePath(context.Context, Path) (Path, error)
	ResolveNode(context.Context, Path) (Node, error)
}

type Link

type Link ipld.Link

type Node

type Node ipld.Node

TODO: should we really copy these?

if we didn't, godoc would generate nice links straight to go-ipld-format

type Path

type Path interface {
	String() string
	Cid() *cid.Cid
	Root() *cid.Cid
	Resolved() bool
}

type Reader

type Reader interface {
	io.ReadSeeker
	io.Closer
}

type UnixfsAPI

type UnixfsAPI interface {
	Add(context.Context, io.Reader) (Path, error)
	Cat(context.Context, Path) (Reader, error)
	Ls(context.Context, Path) ([]*Link, error)
}