Crate libp2p

source ·
Expand description

libp2p is a modular peer-to-peer networking framework.

To learn more about the general libp2p multi-language framework visit libp2p.io.

To get started with this libp2p implementation in Rust, please take a look at the tutorials. Further examples can be found in the examples directory.

Re-exports

pub use bytes;
pub use futures;
pub use self::simple::SimpleProtocol;

Modules

bandwidth
core
Transports, upgrades, multiplexing and node handling of libp2p.
dns
DNS name resolution
identify
Implementation of the Identify protocol.
identity
A node’s network identity keys.
kad
Implementation of the libp2p-specific Kademlia protocol.
mdns
Implementation of the libp2p-specific mDNS protocol.
mplex
Implementation of the Stream Multiplexer Mplex protocol.
multiaddr
multihash
Multihash implementation.
noise
Noise protocol framework support for libp2p.
ping
This module implements the /ipfs/ping/1.0.0 protocol.
request_response
Generic request/response protocols.
simple
swarm
High-level network manager.
tcp
Implementation of the libp2p libp2p_core::Transport trait for TCP/IP.
tutorials
Rust-libp2p Tutorials to get started with.
wasm_ext
Implementation of the libp2p Transport trait for external transports.
websocket
Implementation of the libp2p Transport trait for Websockets.
yamux
Implementation of the Yamux multiplexing protocol for libp2p.

Macros

build_multiaddr
Easy way for a user to create a Multiaddr.

Structs

Multiaddr
Representation of a Multiaddr.
PeerId
Identifier of a peer of the network.
Swarm
Contains the state of the network, plus the way it should behave.

Enums

TransportError
An error during dialing or listening on a Transport.

Traits

InboundUpgrade
Possible upgrade on an inbound connection or substream.
InboundUpgradeExt
Extension trait for InboundUpgrade. Automatically implemented on all types that implement InboundUpgrade.
OutboundUpgrade
Possible upgrade on an outbound connection or substream.
OutboundUpgradeExt
Extention trait for OutboundUpgrade. Automatically implemented on all types that implement OutboundUpgrade.
Transport
A transport provides connection-oriented communication between two peers through ordered streams of data (i.e. connections).
TransportExt
Trait automatically implemented on all objects that implement Transport. Provides some additional utilities.

Functions

tokio_development_transport
Builds a Transport based on TCP/IP that supports the most commonly-used features of libp2p: