Crate rust_ipfs

IPFS node implementation

Ipfs is a peer-to-peer system with content addressed functionality. The main entry point for users of this crate is the Ipfs facade, which allows access to most of the implemented functionality.

This crate passes a lot of the interface-ipfs-core test suite; most of that functionality is in ipfs-http crate. The crate has some interoperability with the go-ipfs and js-ipfs implementations.

ipfs is an early alpha level crate: APIs and their implementation are subject to change in any upcoming release at least for now. The aim of the crate is to become a library-first production ready implementation of an Ipfs node.

Re-exports

pub use self::path::IpfsPath;

pub use self::repo::PinKind;

pub use self::repo::PinMode;

pub use self::repo::RepoTypes;

pub use libp2p;

Modules

config

dag

ipfs.dag interface implementation around Ipfs.

error

Crate-wide errors.

ipns

IPNS functionality around Ipfs.

p2p

P2P handling for IPFS nodes.

path

IpfsPath related functionality for content addressed paths with links.

refs

refs or the references of dag-pb and other supported IPLD formats functionality.

repo

Storage implementation(s) backing the crate::Ipfs.

unixfs

Adaptation for ipfs-unixfs crate functionality on top of crate::Ipfs.

Macros

multiaddr

Easy way for a user to create a Multiaddr.

Structs

BitswapStats

Bitswap statistics

Connection

A description of currently active connection.

Error

The Error type, a wrapper around a dynamic error type.

Ipfs

The facade for the Ipfs node.

IpfsOptions

Ipfs node options used to configure the node to be created with UninitializedIpfs.

Key

The (opaque) key of a record.

ListenerId

The ID of a single listener.

MessageId

Multiaddr

Representation of a Multiaddr.

MultiaddrWithPeerId

A Multiaddr paired with a discrete PeerId. The Multiaddr can contain a Protocol::P2p, but it’s not as easy to work with, and some functionalities don’t support it being contained within the Multiaddr.

MultiaddrWithoutPeerId

A wrapper for Multiaddr that does not contain Protocol::P2p.

PeerId

Identifier of a peer of the network.

SubscriptionStream

Stream of a pubsub messages. Implements [FusedStream].

TestTypes

In-memory testing configuration used in tests.

Types

Default node configuration, currently with persistent block store and data store for pins.

UninitializedIpfs

Configured Ipfs which can only be started.

Enums

BehaviourEvent

FDLimit

KadResult

Represents the result of a Kademlia query.

Keypair

Identity keypair of a node.

Protocol

Protocol describes all possible multiaddress protocols.

PublicKey

The public key of a node’s identity keypair.

PublishError

Error associated with publishing a gossipsub message.

Quorum

A quorum w.r.t. the configured replication factor specifies the minimum number of distinct nodes that must be successfully contacted in order for a query to succeed.

Traits

IpfsTypes

Represents the configuration of the Ipfs node, its backing blockstore and datastore.

NetworkBehaviour

A NetworkBehaviour defines the behaviour of the local node on the network.

Type Definitions

Block

Derive Macros

NetworkBehaviour

Generates a delegating NetworkBehaviour implementation for the struct this is used for. See the trait documentation for better description.