Struct litep2p::addresses::PublicAddresses

pub struct PublicAddresses { /* private fields */ }

Set of the public addresses of the local node.

The format of the addresses stored in the set contain the local peer ID. This requirement is enforced by the PublicAddresses::add_address method, that will add the local peer ID to the address if it is missing.

Note

• The addresses are reported to the identify protocol and are used by other nodes to establish a connection with the local node.

• Users must ensure that the addresses are reachable from the network.

Implementations

impl PublicAddresses

pub fn add_address(&self, address: Multiaddr) -> Result<bool, InsertionError>

Add a public address to the list of addresses.

The address must contain the local peer ID, otherwise an error is returned. In case the address does not contain any peer ID, it will be added.

Returns true if the address was added, false if it was already present.

pub fn remove_address(&self, address: &Multiaddr) -> bool

Remove the exact public address.

The provided address must contain the local peer ID.

pub fn get_addresses(&self) -> Vec<Multiaddr>

Returns a vector of the available listen addresses.

Trait Implementations

impl Clone for PublicAddresses

fn clone(&self) -> PublicAddresses

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PublicAddresses

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

Formats the value using the given formatter.