pin

Documentation

Overview

package pin implements structures and methods to keep track of which objects a user wants to keep stored locally.

Index

• Variables
• func PinModeToString(mode PinMode) (string, bool)
• type PinMode
  • func StringToPinMode(s string) (PinMode, bool)
• type Pinned
  • func (p Pinned) Pinned() bool
  • func (p Pinned) String() string
• type Pinner
  • func LoadPinner(d ds.Datastore, dserv, internal mdag.DAGService) (Pinner, error)
  • func NewPinner(dstore ds.Datastore, serv, internal mdag.DAGService) Pinner

Variables

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

Functions

func PinModeToString

func PinModeToString(mode PinMode) (string, bool)

Types

type PinMode

type PinMode int

const (
	Recursive PinMode = iota
	Direct
	Indirect
	Internal
	NotPinned
	Any
)

func StringToPinMode

func StringToPinMode(s string) (PinMode, bool)

type Pinned

type Pinned struct {
	Key  *cid.Cid
	Mode PinMode
	Via  *cid.Cid
}

func (Pinned) Pinned

func (p Pinned) Pinned() bool

func (Pinned) String

func (p Pinned) String() string

type Pinner

type Pinner interface {
	IsPinned(*cid.Cid) (string, bool, error)
	IsPinnedWithType(*cid.Cid, PinMode) (string, bool, error)
	Pin(context.Context, node.Node, bool) error
	Unpin(context.Context, *cid.Cid, bool) error

	// Update updates a recursive pin from one cid to another
	// this is more efficient than simply pinning the new one and unpinning the
	// old one
	Update(ctx context.Context, from, to *cid.Cid, unpin bool) error

	// Check if a set of keys are pinned, more efficient than
	// calling IsPinned for each key
	CheckIfPinned(cids ...*cid.Cid) ([]Pinned, error)

	// PinWithMode is for manually editing the pin structure. Use with
	// care! If used improperly, garbage collection may not be
	// successful.
	PinWithMode(*cid.Cid, PinMode)

	// RemovePinWithMode is for manually editing the pin structure.
	// Use with care! If used improperly, garbage collection may not
	// be successful.
	RemovePinWithMode(*cid.Cid, PinMode)

	Flush() error
	DirectKeys() []*cid.Cid
	RecursiveKeys() []*cid.Cid
	InternalPins() []*cid.Cid
}

func LoadPinner

func LoadPinner(d ds.Datastore, dserv, internal mdag.DAGService) (Pinner, error)

LoadPinner loads a pinner and its keysets from the given datastore

func NewPinner

func NewPinner(dstore ds.Datastore, serv, internal mdag.DAGService) Pinner

NewPinner creates a new pinner using the given datastore as a backend