ldpinner

Documentation

Overview

Package ldpinner implements structures and methods to keep track of which objects a user wants to keep stored locally. This implementation stores pin information in a mdag structure.

Index

• Variables
• func LoadKeys(ctx context.Context, dstore ds.Datastore, dserv, internal ld.DAGService, ...) error
• func New(dstore ds.Datastore, dserv, internal ld.DAGService) (*pinner, error)

Variables

var ErrNotPinned = fmt.Errorf("not pinned or pinned indirectly")

ErrNotPinned is returned when trying to unpin items which are not pinned.

Functions

func LoadKeys

func LoadKeys(ctx context.Context, dstore ds.Datastore, dserv, internal ld.DAGService, recursive bool, keyChan chan<- cid.Cid) error

LoadKeys reads the pinned CIDs and sends them on the given channel. This is used to read pins without loading them all into memory.

func New

func New(dstore ds.Datastore, dserv, internal ld.DAGService) (*pinner, error)

New creates a new pinner using the given datastore as a backend, and loads the pinner's keysets from the datastore