Struct libp2p_bitswap::Bitswap

pub struct Bitswap<MH = Multihash> { /* fields omitted */ }

Network behaviour that handles sending and receiving IPFS blocks.

Implementations

impl<MH: MultihashDigest> Bitswap<MH>

pub fn new() -> Self

Creates a new Bitswap.

pub fn connect(&mut self, peer_id: PeerId)

Connect to peer.

Called from discovery protocols like mdns or kademlia.

pub fn send_block(&mut self, peer_id: &PeerId, cid: Cid, data: Box<[u8]>)

Sends a block to the peer.

Called from a Strategy.

pub fn send_block_all(&mut self, cid: &Cid, data: &[u8])

Sends a block to all peers that sent a want.

pub fn want_block(&mut self, cid: Cid, priority: Priority)

Queues the wanted block for all peers.

A user request

pub fn cancel_block(&mut self, cid: &Cid)

Removes the block from our want list and updates all peers.

Can be either a user request or be called when the block was received.

pub fn wantlist(&self, peer_id: Option<&PeerId>) -> Vec<(Cid, Priority)>

Retrieves the want list of a peer.

pub fn peers<'a>(&'a self) -> impl Iterator<Item = &'a PeerId> + 'a

Retrieves the connected bitswap peers.

pub fn peers_want<'a>(
    &'a self,
    cid: &'a Cid
) -> impl Iterator<Item = &'a PeerId> + 'a

Retrieves the peers that want a block.

Trait Implementations

impl<MH> Default for Bitswap<MH>

fn default() -> Self

Returns the "default value" for a type.

impl<MH: MultihashDigest> NetworkBehaviour for Bitswap<MH>

type ProtocolsHandler = OneShotHandler<BitswapConfig<MH>, BitswapMessage<MH>, BitswapMessage<MH>>

Handler for all the protocols the network behaviour supports.

type OutEvent = BitswapEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

fn new_handler(&mut self) -> Self::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

fn addresses_of_peer(&mut self, _peer_id: &PeerId) -> Vec<Multiaddr>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

fn inject_connected(&mut self, peer_id: &PeerId)

Indicates the behaviour that we connected to the node with the given peer id.

fn inject_disconnected(&mut self, peer_id: &PeerId)

Indicates the behaviour that we disconnected from the node with the given peer id.

fn inject_event(
    &mut self,
    peer_id: PeerId,
    connection: ConnectionId,
    message: BitswapMessage<MH>
)

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

fn poll(
    &mut self,
    _: &mut Context<'_>,
    _: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<<Self::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.

fn inject_connection_established(
    &mut self,
    &PeerId,
    &ConnectionId,
    &ConnectedPoint
)

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(&mut self, &PeerId, &ConnectionId, &ConnectedPoint)

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the [ConnectedPoint] of an existing connection has changed.

fn inject_addr_reach_failure(
    &mut self,
    _peer_id: Option<&PeerId>,
    _addr: &Multiaddr,
    _error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, _peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

fn inject_new_listen_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that a new multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.