Categorygithub.com/ipfs/go-ipfs-pinner
modulepackage
0.3.1
Repository: https://github.com/ipfs/go-ipfs-pinner.git
Documentation: pkg.go.dev

# README

go-ipfs-pinner

Coverage Status Travis CI

ā— This repo is no longer maintained.

šŸ‘‰ We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/pinning/pinner. šŸŽļø Good news! There is tooling and documentation to expedite a switch in your repo.

āš ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).

šŸ“š Learn more, including how to take the maintainership mantle or ask questions, here.

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/ipfs/go-ipfs-pinner

Requires Go 1.13

Documentation

https://godoc.org/github.com/ipfs/go-ipfs-pinner

License

This library is dual-licensed under Apache 2.0 and MIT terms.

Copyright 2019. Protocol Labs, Inc.

# Packages

Package dsindex provides secondary indexing functionality for a datastore.
Package dspinner implements structures and methods to keep track of which objects a user wants to keep stored locally.

# Functions

ModeToString returns a human-readable name for the Mode.
StringToMode parses the result of ModeToString() back to a Mode.

# Constants

Any refers to any pinned cid Deprecated: use github.com/ipfs/boxo/pinning/pinner.Any.
Direct pins pin just the target cid.
Indirect pins are cids who have some ancestor pinned recursively.
Internal pins are cids used to keep the internal state of the pinner.
NotPinned Deprecated: use github.com/ipfs/boxo/pinning/pinner.NotPinned.
Recursive pins pin the target cids along with any reachable children.

# Variables

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

# Structs

Pinned represents CID which has been pinned with a pinning strategy.

# Interfaces

A Pinner provides the necessary methods to keep track of Nodes which are to be kept locally, according to a pin mode.

# Type aliases

Mode allows to specify different types of pin (recursive, direct etc.).