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 AddWithContext(ctx context.Context, n *core.IpfsNode, r io.Reader) (string, error)
• func AddWrapped(n *core.IpfsNode, r io.Reader, filename string) (string, ipld.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)
• type AddedObject
• type Adder
  • func NewAdder(ctx context.Context, p pin.Pinner, bs bstore.GCBlockstore, ds ipld.DAGService) (*Adder, error)
  • func (adder *Adder) AddFile(file files.File) error
  • func (adder *Adder) Finalize() (ipld.Node, error)
  • func (adder *Adder) PinRoot() error
  • func (adder *Adder) RootNode() (ipld.Node, error)
  • func (adder *Adder) SetMfsRoot(r *mfs.Root)
• type Link
• type Object

Functions

func Add

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

Add builds a merkledag node from a reader, adds it to the blockstore, and returns the key representing that node. If you want to pin it, use NewAdder() and Adder.PinRoot().

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 AddWithContext

func AddWithContext(ctx context.Context, n *core.IpfsNode, r io.Reader) (string, error)

AddWithContext does the same as Add, but with a custom context.

func AddWrapped

func AddWrapped(n *core.IpfsNode, r io.Reader, filename string) (string, ipld.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)

Types

type AddedObject

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

type Adder

type Adder struct {
	Out       chan interface{}
	Progress  bool
	Hidden    bool
	Pin       bool
	Trickle   bool
	RawLeaves bool
	Silent    bool
	Wrap      bool
	NoCopy    bool
	Chunker   string

	Prefix *cid.Prefix
	// contains filtered or unexported fields
}

Adder holds the switches passed to the `add` command.

func NewAdder

func NewAdder(ctx context.Context, p pin.Pinner, bs bstore.GCBlockstore, ds ipld.DAGService) (*Adder, error)

NewAdder Returns a new Adder used for a file add operation.

func (*Adder) AddFile

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

AddFile adds the given file while respecting the adder.

func (*Adder) Finalize

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

Finalize flushes the mfs root directory and returns the mfs root node.

func (*Adder) PinRoot

func (adder *Adder) PinRoot() error

Recursively pins the root node of Adder and writes the pin state to the backing datastore.

func (*Adder) RootNode

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

RootNode returns the root node of the Added.

func (*Adder) SetMfsRoot

func (adder *Adder) SetMfsRoot(r *mfs.Root)

SetMfsRoot sets `r` as the root for Adder.

type Link

type Link struct {
	Name, Hash string
	Size       uint64
}

type Object

type Object struct {
	Hash  string
	Links []Link
	Size  string
}