Expand description
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 block::Block;pub use self::p2p::BehaviourEvent;pub use self::p2p::KadResult;pub use self::path::IpfsPath;pub use self::repo::PinKind;pub use self::repo::PinMode;pub use libp2p;
Modules§
- block
- config
- dag
ipfs.daginterface implementation aroundIpfs.- error
- Crate-wide errors.
- ipns
- IPNS functionality around
Ipfs. - p2p
- P2P handling for IPFS nodes.
- path
IpfsPathrelated functionality for content addressed paths with links.- refs
refsor the references of dag-pb and other supported IPLD formats functionality.- repo
- Storage implementation(s) backing the
crate::Ipfs. - unixfs
- Adaptation for
ipfs-unixfscrate functionality on top ofcrate::Ipfs.
Macros§
- multiaddr
- Easy way for a user to create a
Multiaddr.
Structs§
- AddPeer
Opt - Connection
Limits - The configurable connection limits.
- Error
- Just re-export anyhow for now.
- Ipfs
- The facade for the Ipfs node.
- Key
- The (opaque) key of a record.
- Keypair
- Identity keypair of a node.
- Listener
Id - The ID of a single listener.
- Message
Id - Multiaddr
- Representation of a Multiaddr.
- Optional
Stream Protocol - PeerId
- Identifier of a peer of the network.
- Public
Key - The public key of a node’s identity keypair.
- Subscription
Stream - Stream of a pubsub messages. Implements
FusedStream. - Uninitialized
Ipfs - Configured Ipfs which can only be started.
Enums§
- Connection
Events - DhtMode
- FDLimit
- Peer
Connection Events - Protocol
Protocoldescribes all possible multiaddress protocols.- Publish
Error - Error associated with publishing a gossipsub message.
- Pubsub
Event - 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.
- Repo
Provider - Storage
Type
Traits§
- Into
AddPeer Opt - Into
Request - Into
Stream Protocol - Network
Behaviour - A
NetworkBehaviourdefines the behaviour of the local node on the network.
Type Aliases§
Derive Macros§
- Network
Behaviour - Generates a delegating
NetworkBehaviourimplementation for the struct this is used for. See the trait documentation for better description.