Struct AddrInfo

pub struct AddrInfo {
    pub relay_url: Option<RelayUrl>,
    pub direct_addresses: BTreeSet<SocketAddr>,
}

Network paths to contact an iroh-net node.

This contains zero or more network paths to establish a connection to an iroh-net node. Unless a [discovery service] is used at least one path is required to connect to an other node, see NodeAddr for details.

Fields

relay_url: Option<RelayUrl>

The node’s home relay url.

direct_addresses: BTreeSet<SocketAddr>

Socket addresses where the peer might be reached directly.

Implementations

impl AddrInfo

pub fn is_empty(&self) -> bool

Returns whether this addressing information is empty.

pub fn apply_options(&mut self, opts: AddrInfoOptions)

Applies the options to self.

This is used to more tightly control the information stored in ab AddrInfo received from another API. E.g. to ensure a discovery service is used the AddrInfoOptions::Id] option could be used to remove all other addressing details.

Trait Implementations

impl Clone for AddrInfo

fn clone(&self) -> AddrInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddrInfo

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

Formats the value using the given formatter.

impl Default for AddrInfo

fn default() -> AddrInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddrInfo

fn deserialize<__D>( __deserializer: __D, ) -> Result<AddrInfo, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NodeInfo> for AddrInfo

fn from(value: NodeInfo) -> Self

Converts to this type from the input type.

impl Ord for AddrInfo

fn cmp(&self, other: &AddrInfo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AddrInfo

fn eq(&self, other: &AddrInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AddrInfo

fn partial_cmp(&self, other: &AddrInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AddrInfo

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AddrInfo

impl StructuralPartialEq for AddrInfo