coreipfs

Documentation

Index

• Variables
• type CoreIpfs
  • func New(ds datastore.TxnDatastore, ipfs iface.CoreAPI, l ffs.JobLogger) (*CoreIpfs, error)
  • func (ci *CoreIpfs) GCStaged(ctx context.Context, exclude []cid.Cid, olderThan time.Time) ([]cid.Cid, error)
  • func (ci *CoreIpfs) Get(ctx context.Context, c cid.Cid) (io.Reader, error)
  • func (ci *CoreIpfs) IsPinned(ctx context.Context, iid ffs.APIID, c cid.Cid) (bool, error)
  • func (ci *CoreIpfs) Pin(ctx context.Context, iid ffs.APIID, c cid.Cid) (int, error)
  • func (ci *CoreIpfs) PinnedCids(ctx context.Context) ([]ffs.PinnedCid, error)
  • func (ci *CoreIpfs) Replace(ctx context.Context, iid ffs.APIID, c1 cid.Cid, c2 cid.Cid) (int, error)
  • func (ci *CoreIpfs) Stage(ctx context.Context, iid ffs.APIID, r io.Reader) (cid.Cid, error)
  • func (ci *CoreIpfs) StageCid(ctx context.Context, iid ffs.APIID, c cid.Cid) error
  • func (ci *CoreIpfs) Unpin(ctx context.Context, iid ffs.APIID, c cid.Cid) error

Variables

var (

	// ErrUnpinnedCid indicates that the operation failed because
	// the provided cid is unpinned.
	ErrUnpinnedCid = errors.New("can't unpin an unpinned cid")
	// ErrReplaceFromNotPinned indicates that the source cid to be replaced
	// isn't pinned.
	ErrReplaceFromNotPinned = errors.New("c1 isn't pinned")
)

Types

type CoreIpfs

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

CoreIpfs is an implementation of HotStorage interface which saves data into a remote go-ipfs using the HTTP API.

func New

func New(ds datastore.TxnDatastore, ipfs iface.CoreAPI, l ffs.JobLogger) (*CoreIpfs, error)

New returns a new CoreIpfs instance.

func (*CoreIpfs) GCStaged

func (ci *CoreIpfs) GCStaged(ctx context.Context, exclude []cid.Cid, olderThan time.Time) ([]cid.Cid, error)

GCStaged unpins Cids that are only pinned by Stage() calls and all pins satisfy the filters.

func (*CoreIpfs) Get

func (ci *CoreIpfs) Get(ctx context.Context, c cid.Cid) (io.Reader, error)

Get retrieves a cid data from the IPFS node.

func (*CoreIpfs) IsPinned

func (ci *CoreIpfs) IsPinned(ctx context.Context, iid ffs.APIID, c cid.Cid) (bool, error)

IsPinned returns true if c is pinned by iid.

func (*CoreIpfs) Pin

func (ci *CoreIpfs) Pin(ctx context.Context, iid ffs.APIID, c cid.Cid) (int, error)

Pin a cid for an APIID. If the cid was already pinned by a stage from APIID, the Cid is considered fully-pinned and not a candidate to be unpinned by GCStaged().

func (*CoreIpfs) PinnedCids

func (ci *CoreIpfs) PinnedCids(ctx context.Context) ([]ffs.PinnedCid, error)

PinnedCids return detailed information about pinned cids.

func (*CoreIpfs) Replace

func (ci *CoreIpfs) Replace(ctx context.Context, iid ffs.APIID, c1 cid.Cid, c2 cid.Cid) (int, error)

Replace moves the pin from c1 to c2. If c2 was already pinned from a stage, it's considered fully-pinned and not GCable.

func (*CoreIpfs) Stage

func (ci *CoreIpfs) Stage(ctx context.Context, iid ffs.APIID, r io.Reader) (cid.Cid, error)

Stage adds the data of io.Reader in the storage, and creates a stage-pin on the resulting cid.

func (*CoreIpfs) StageCid

func (ci *CoreIpfs) StageCid(ctx context.Context, iid ffs.APIID, c cid.Cid) error

StageCid pull the Cid data and stage-pin it.

func (*CoreIpfs) Unpin

func (ci *CoreIpfs) Unpin(ctx context.Context, iid ffs.APIID, c cid.Cid) error

Unpin unpins a Cid for an APIID. If the Cid isn't pinned, it returns ErrUnpinnedCid.