Package pb provides protobuf definitions for serialized types in Cluster.go:generate protoc -I=.

Package rest implements an IPFS Cluster API component.

AddParamsFromQuery parses the AddParams object from a URL.Query().

DefaultAddParams returns a AddParams object with standard defaults.

IPFSPinStatusFromString parses a string and returns the matching IPFSPinStatus.

NewMultiaddr returns a cluster Multiaddr wrapper creating the multiaddr.Multiaddr with the given string.

NewMultiaddrWithValue returns a new cluster Multiaddr wrapper using the given multiaddr.Multiaddr.

PeersToStrings Encodes a list of peers.

PinCid is a shortcut to create a Pin only with a Cid.

PinModeFromString converst a string to PinMode.

PinTypeFromString is the inverse of String.

PinWithOpts creates a new Pin calling PinCid(c) and then sets its PinOptions fields with the given options.

StringsToPeers decodes peer.IDs from strings.

TrackerStatusAll all known TrackerStatus values.

TrackerStatusFromString parses a string and returns the matching TrackerStatus value.

AllType is a PinType used for filtering all pin types.

BadType type showing up anywhere indicates a bug.

ClusterDAGType pins carry the CID of the root node that points to all the shard-root-nodes of the shards in which a DAG has been divided.

DataType is a regular, non-sharded pin.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

IPFSPinStatus values FIXME include maxdepth.

MetaType tracks the original CID of a sharded DAG.

PinMode values.

PinMode values.

ShardType pins carry the root CID of a shard, which points to individual blocks on the original DAG that the user is adding, which has been sharded.

The cluster node is offline or not responding.

Composite TrackerStatus.

An error occurred pinning.

The IPFS daemon has pinned the item.

The IPFS daemon is currently pinning the item.

The item has been queued for pinning on the IPFS daemon.

Composite TrackerStatus.

The IPFS daemon is not pinning the item but it is being tracked.

The IPFS daemon is not pinning the item through this cid but it is tracked in a cluster dag.

IPFSStatus should never take this value.

An error occurred unpinning.

The IPFS daemon is not pinning the item.

The IPFS daemon is currently unpinning the item.

The item has been queued for unpinning on the IPFS daemon.

100 MB.

AddedOutput carries information for displaying the standard ipfs output indicating a node of a file has been added.

AddParams contains all of the configurable parameters needed to specify the importing process of a file being added to an ipfs-cluster.

Alert carries alerting information about a peer.

ConnectGraph holds information about the connectivity of the cluster To read, traverse the keys of ClusterLinks.

Error can be used by APIs to return errors.

GlobalPinInfo contains cluster-wide status information about a tracked Cid, indexed by cluster peer.

GlobalRepoGC contains cluster-wide information about garbage collected CIDs from IPFS.

ID holds information about the Cluster peer.

IPFSID is used to store information about the underlying IPFS daemon.

IPFSRepoGC represents the streaming response sent from repo gc API of IPFS.

IPFSRepoStat wraps information about the IPFS repository.

Metric transports information about a peer.ID.

Multiaddr is a concrete type to wrap a Multiaddress so that it knows how to serialize and deserialize itself.

NodeWithMeta specifies a block of data and a set of optional metadata fields carrying information about the encoded ipld node.

Pin carries all the information associated to a CID that is pinned in IPFS Cluster.

PinInfo holds information about local pins.

PinInfoShort is a subset of PinInfo which is embedded in GlobalPinInfo objects and does not carry redundant information as PinInfo would.

PinOptions wraps user-defined options for Pins.

PinPath is a wrapper for holding pin options and path of the content.

RepoGC contains garbage collected CIDs from a cluster peer's IPFS daemon.

Version holds version information.

IPFSPinStatus represents the status of a pin in IPFS (direct, recursive etc.).

MetricSlice is a sortable Metric array.

PinDepth indicates how deep a pin should be pinned, with -1 meaning "to the bottom", or "recursive".

PinMode is a PinOption that indicates how to pin something on IPFS, recursively or direct.

PinType specifies which sort of Pin object we are dealing with.

TrackerStatus represents the status of a tracked Cid in the PinTracker.