Struct Addresses

pub struct Addresses { /* private fields */ }

Available on crate feature kad only.

A non-empty list of (unique) addresses of a peer in the routing table. Every address must be a fully-qualified /p2p address.

Implementations

impl Addresses

pub fn new(addr: Multiaddr) -> Addresses

Creates a new list of addresses.

pub fn first(&self) -> &Multiaddr

Gets a reference to the first address in the list.

pub fn iter(&self) -> impl Iterator<Item = &Multiaddr>

Returns an iterator over the addresses.

pub fn len(&self) -> usize

Returns the number of addresses in the list.

pub fn into_vec(self) -> Vec<Multiaddr>

Converts the addresses into a Vec.

pub fn remove(&mut self, addr: &Multiaddr) -> Result<(), ()>

Removes the given address from the list.

Returns Ok(()) if the address is either not in the list or was found and removed. Returns Err(()) if the address is the last remaining address, which cannot be removed.

An address should only be removed if is determined to be invalid or otherwise unreachable.

pub fn insert(&mut self, addr: Multiaddr) -> bool

Adds a new address to the end of the list.

Returns true if the address was added, false otherwise (i.e. if the address is already in the list).

pub fn replace(&mut self, old: &Multiaddr, new: &Multiaddr) -> bool

Replaces an old address with a new address.

Returns true if the previous address was found and replaced with a clone of the new address, returns false otherwise.

Trait Implementations

impl Clone for Addresses

fn clone(&self) -> Addresses

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Addresses

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

Formats the value using the given formatter.