README
¶
go-btfs-pinner
Background
The pinner system is responsible for keeping track of which objects a user wants to keep stored locally
Install
Via go get:
$ go get github.com/TRON-US/go-btfs-pinner
Requires Go 1.13
Documentation
https://godoc.org/github.com/TRON-US/go-btfs-pinner
Contribute
PRs are welcome!
Small note: If editing the Readme, please conform to the standard-readme specification.
License
This library is dual-licensed under Apache 2.0 and MIT terms.
Copyright 2020. TRON-US.
Documentation
¶
Overview ¶
Package pin implements structures and methods to keep track of which objects a user wants to keep stored locally.
Index ¶
Constants ¶
const ( DefaultDurationUnit = time.Hour * 24 DefaultDurationCount = 0 )
Variables ¶
var ErrNotPinned = fmt.Errorf("not pinned or pinned indirectly")
ErrNotPinned is returned when trying to unpin items which are not pinned.
Functions ¶
func ExpiresAtWithUnitAndCount ¶
Returns time.Unix value for the given `durationUnit` and `durationCount` from now.
func ModeToString ¶
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 NotPinned // Any refers to any pinned cid Any )
Pin Modes
func StringToMode ¶
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 ¶
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).
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(ctx context.Context, node ipld.Node, recursive bool, expir uint64) 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.
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(cid.Cid, uint64, Mode)
// RemovePinWithMode is for manually editing the pin structure.
// Use with care! If used improperly, garbage collection may not
// be successful.
RemovePinWithMode(cid.Cid, Mode)
// Flush writes the pin state to the backing datastore
Flush(ctx context.Context) error
// DirectKeys returns all directly pinned cids
DirectKeys(ctx context.Context) ([]cid.Cid, error)
// DirectMap returns all directly pinned cids and its values
DirectMap(ctx context.Context) (*cid.Map, error)
// DirectKeys returns all recursively pinned cids
RecursiveKeys(ctx context.Context) ([]cid.Cid, error)
// RecursiveMap returns all recursively pinned cids and its values
RecursiveMap(ctx context.Context) (*cid.Map, error)
// InternalPins returns all cids kept pinned for the internal state of the
// pinner
InternalPins(ctx context.Context) ([]cid.Cid, error)
// HasExpiration returns true if the given Cid or its ancestor has
// expiration time
HasExpiration(ctx context.Context, cid cid.Cid) (bool, error)
// IsExpiredPin checks if the given Cid has already expired
IsExpiredPin(ctx context.Context, c cid.Cid) bool
}
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 in charge of keeping the list of items from the local storage that should not be garbage-collected.
func LoadPinner ¶
LoadPinner loads a pinner and its keysets from the given datastore
Source Files
Directories