coreunix

Documentation

Index

• func Add(n *core.IpfsNode, r io.Reader) (string, error)
• func AddMetadataTo(n *core.IpfsNode, skey string, m *ft.Metadata) (string, error)
• func AddR(n *core.IpfsNode, root string) (key string, err error)
• func AddWrapped(n *core.IpfsNode, r io.Reader, filename string) (string, *dag.Node, error)
• func Cat(ctx context.Context, n *core.IpfsNode, pstr string) (*uio.DagReader, error)
• func Metadata(n *core.IpfsNode, skey string) (*ft.Metadata, error)
• func NewMemoryDagService() dag.DAGService
• type AddedObject
• type Adder
  • func NewAdder(ctx context.Context, n *core.IpfsNode, out chan interface{}) (*Adder, error)
  • func (adder *Adder) AddFile(file files.File) error
  • func (adder *Adder) Finalize() (*dag.Node, error)
  • func (adder *Adder) PinRoot() error
  • func (adder *Adder) RootNode() (*dag.Node, error)
• type Link
• type Object

Functions

func Add

func Add(n *core.IpfsNode, r io.Reader) (string, error)

Add builds a merkledag from the a reader, pinning all objects to the local datastore. Returns a key representing the root node.

func AddMetadataTo

func AddMetadataTo(n *core.IpfsNode, skey string, m *ft.Metadata) (string, error)

func AddR

func AddR(n *core.IpfsNode, root string) (key string, err error)

AddR recursively adds files in |path|.

func AddWrapped

func AddWrapped(n *core.IpfsNode, r io.Reader, filename string) (string, *dag.Node, error)

AddWrapped adds data from a reader, and wraps it with a directory object to preserve the filename. Returns the path of the added file ("<dir hash>/filename"), the DAG node of the directory, and and error if any.

func Cat

func Cat(ctx context.Context, n *core.IpfsNode, pstr string) (*uio.DagReader, error)

func Metadata

func Metadata(n *core.IpfsNode, skey string) (*ft.Metadata, error)

func NewMemoryDagService

func NewMemoryDagService() dag.DAGService

Types

type AddedObject

type AddedObject struct {
	Name  string
	Hash  string `json:",omitempty"`
	Bytes int64  `json:",omitempty"`
}

type Adder

type Adder struct {
	Progress bool
	Hidden   bool
	Pin      bool
	Trickle  bool
	Silent   bool
	Wrap     bool
	Chunker  string
	// contains filtered or unexported fields
}

Internal structure for holding the switches passed to the `add` call

func NewAdder

func NewAdder(ctx context.Context, n *core.IpfsNode, out chan interface{}) (*Adder, error)

func (*Adder) AddFile

func (adder *Adder) AddFile(file files.File) error

Add the given file while respecting the adder.

func (*Adder) Finalize

func (adder *Adder) Finalize() (*dag.Node, error)

func (*Adder) PinRoot

func (adder *Adder) PinRoot() error

func (*Adder) RootNode

func (adder *Adder) RootNode() (*dag.Node, error)

type Link

type Link struct {
	Name, Hash string
	Size       uint64
}

type Object

type Object struct {
	Hash  string
	Links []Link
}