Package rest implements an IPFS Cluster API component.

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

CidsToStrings encodes cid.Cids to strings.

DefaultAddParams returns a AddParams object with standard defaults.

IPFSPinStatusFromString parses a string and returns the matching IPFSPinStatus.

Libp2pMultiaddrSplit takes a LibP2P multiaddress (/<multiaddr>/ipfs/<peerID>) and decapsulates it, parsing the peer ID.

MultiaddrsToSerial converts a slice of Multiaddresses to its serializable form.

MultiaddrToSerial converts a Multiaddress to its serializable form.

MustLibp2pMultiaddrJoin takes a LibP2P multiaddress and a peer ID and encapsulates a new /ipfs/<peerID> address.

PeersToStrings IDB58Encodes a list of peers.

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

PinTypeFromString is the inverse of String.

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

StringsToCidSet decodes cid.Cids from strings.

StringsToPeers decodes peer.IDs from strings.

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.

MetaType tracks the original CID of a sharded DAG.

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.

IPFSStatus should never take this value.

The cluster node is offline or not responding.

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.

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.

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.

ConnectGraphSerial is the serializable ConnectGraph counterpart for RPC requests.

Error can be used by APIs to return errors.

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

GlobalPinInfoSerial is the serializable version of GlobalPinInfo.

ID holds information about the Cluster peer.

IDSerial is the serializable ID counterpart for RPC requests.

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

IPFSIDSerial is the serializable IPFSID for RPC requests.

IPFSRepoStat wraps information about the IPFS repository.

Metric transports information about a peer.ID.

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.

PinInfoSerial is a serializable version of PinInfo.

PinOptions wraps user-defined options for Pins.

PinSerial is a serializable version of Pin.

Version holds version information.

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

MultiaddrSerial is a Multiaddress in a serializable form.

MultiaddrsSerial is an array of Multiaddresses in serializable form.

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

SwarmPeers lists an ipfs daemon's peers.

SwarmPeersSerial is the serialized form of SwarmPeers for RPC use.

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