dspinner

Documentation

Overview

Package dspinner implements structures and methods to keep track of which objects a user wants to keep stored locally. This implementation stores pin data in a datastore.

Index

• Variables
• func New(ctx context.Context, dstore ds.Datastore, dserv ipld.DAGService) (ipfspinner.Pinner, error)

Variables

var (
	// ErrNotPinned is returned when trying to unpin items that are not pinned.
	ErrNotPinned = errors.New("not pinned or pinned indirectly")
)

Functions

func New

func New(ctx context.Context, dstore ds.Datastore, dserv ipld.DAGService) (ipfspinner.Pinner, error)

New creates a new pinner and loads its keysets from the given datastore. If there is no data present in the datastore, then an empty pinner is returned.