Struct libp2p_swarm::behaviour::PeerAddresses

pub struct PeerAddresses(/* private fields */);

Struct for tracking peers’ external addresses of the Swarm.

Implementations

impl PeerAddresses

pub fn new(number_of_peers: NonZeroUsize) -> Self

Creates a PeerAddresses cache with capacity for the given number of peers.

For each peer, we will at most store 10 addresses.

pub fn on_swarm_event(&mut self, event: &FromSwarm<'_>) -> bool

Feed a FromSwarm event to this struct.

Returns whether the event changed peer’s known external addresses.

pub fn add(&mut self, peer: PeerId, address: Multiaddr) -> bool

Adds address to cache. Appends address to the existing set if peer addresses already exist. Creates a new cache entry for peer_id if no addresses are present. Returns true if the newly added address was not previously in the cache.

pub fn get(&mut self, peer: &PeerId) -> impl Iterator<Item = Multiaddr> + '_

Returns peer’s external addresses.

pub fn remove(&mut self, peer: &PeerId, address: &Multiaddr) -> bool

Removes address from peer addresses cache. Returns true if the address was removed.

Trait Implementations

impl Debug for PeerAddresses

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PeerAddresses

fn default() -> Self

Returns the “default value” for a type.