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 ModeToString(mode Mode) (string, bool)
• type Mode
  • func StringToMode(s string) (Mode, bool)
• type Pinned
  • func (p Pinned) Pinned() bool
  • func (p Pinned) String() string
• type Pinner
• type StreamedPin

Variables

var ErrNotPinned = errors.New("not pinned or pinned indirectly")

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

Functions

func ModeToString

func ModeToString(mode Mode) (string, bool)

ModeToString returns a human-readable name for the Mode.

Types

type Mode

type Mode int

Mode allows to specify different types of pin (recursive, direct etc.). See the Pin Modes constants for a full list.

const (
	// Recursive pins pin the target cids along with any reachable children.
	Recursive Mode = iota

	// Direct pins pin just the target cid.
	Direct

	// Indirect pins are cids who have some ancestor pinned recursively.
	Indirect

	// Internal pins are cids used to keep the internal state of the pinner.
	Internal

	// NotPinned is a value to indicated that a cid is not pinned.
	NotPinned

	// Any refers to any pinned cid
	Any
)

Pin Modes

func StringToMode

func StringToMode(s string) (Mode, bool)

StringToMode parses the result of ModeToString() back to a Mode. It returns a boolean which is set to false if the mode is unknown.

type Pinned

type Pinned struct {
	Key  cid.Cid
	Mode Mode
	Name string
	Via  cid.Cid
}

Pinned represents CID which has been pinned with a pinning strategy. The Via field allows to identify the pinning parent of this CID, in the case that the item is not pinned directly (but rather pinned recursively by some ascendant).

func (Pinned) Pinned

func (p Pinned) Pinned() bool

Pinned returns whether or not the given cid is pinned

func (Pinned) String

func (p Pinned) String() string

String Returns pin status as string

type Pinner

type Pinner interface {
	// IsPinned returns whether or not the given cid is pinned
	// and an explanation of why its pinned
	IsPinned(ctx context.Context, c cid.Cid) (string, bool, error)

	// IsPinnedWithType returns whether or not the given cid is pinned with the
	// given pin type, as well as returning the type of pin its pinned with.
	IsPinnedWithType(ctx context.Context, c cid.Cid, mode Mode) (string, bool, error)

	// Pin the given node, optionally recursively.
	// Pin will make sure that the given node and its children if recursive is set
	// are stored locally. Pinning with a different name for an already existing
	// pin must replace the existing name.
	Pin(ctx context.Context, node ipld.Node, recursive bool, name string) error

	// Unpin the given cid. If recursive is true, removes either a recursive or
	// a direct pin. If recursive is false, only removes a direct pin.
	// If the pin doesn't exist, return ErrNotPinned
	Unpin(ctx context.Context, cid cid.Cid, recursive 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(ctx context.Context, 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(context.Context, cid.Cid, Mode, string) error

	// Flush writes the pin state to the backing datastore
	Flush(ctx context.Context) error

	// DirectKeys returns all directly pinned cids
	DirectKeys(ctx context.Context, detailed bool) <-chan StreamedPin

	// RecursiveKeys returns all recursively pinned cids
	RecursiveKeys(ctx context.Context, detailed bool) <-chan StreamedPin

	// InternalPins returns all cids kept pinned for the internal state of the
	// pinner
	InternalPins(ctx context.Context, detailed bool) <-chan StreamedPin
}

A Pinner provides the necessary methods to keep track of Nodes which are to be kept locally, according to a pin mode. In practice, a Pinner is in charge of keeping the list of items from the local storage that should not be garbage-collected.

type StreamedPin

type StreamedPin struct {
	Pin Pinned
	Err error
}

StreamedPin encapsulate a [Pin] and an error for a function to return a channel of [Pin]s.