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 Pinner
  • func LoadPinner(d ds.Datastore, dserv mdag.DAGService) (Pinner, error)
  • func NewPinner(dstore ds.Datastore, serv 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 Pinner

type Pinner interface {
	IsPinned(key.Key) (string, bool, error)
	IsPinnedWithType(key.Key, PinMode) (string, bool, error)
	Pin(context.Context, *mdag.Node, bool) error
	Unpin(context.Context, key.Key, bool) error

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

	Flush() error
	DirectKeys() []key.Key
	RecursiveKeys() []key.Key
	InternalPins() []key.Key
}

func LoadPinner

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

LoadPinner loads a pinner and its keysets from the given datastore

func NewPinner

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

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