Struct NodeAddr

pub struct NodeAddr {
    pub node_id: NodeId,
    pub relay_url: Option<RelayUrl>,
    pub direct_addresses: BTreeSet<SocketAddr>,
}

Available on crate feature key only.

Network-level addressing information for an iroh node.

This combines a node’s identifier with network-level addressing information of how to contact the node.

To establish a network connection to a node both the NodeId and one or more network paths are needed. The network paths can come from various sources:

• A discovery service which can provide routing information for a given NodeId.

• A RelayUrl of the node’s home relay, this allows establishing the connection via the Relay server and is very reliable.

• One or more direct addresses on which the node might be reachable. Depending on the network location of both nodes it might not be possible to establish a direct connection without the help of a Relay server.

This structure will always contain the required NodeId and will contain an optional number of network-level addressing information. It is a generic addressing type used whenever a connection to other nodes needs to be established.

Fields

node_id: NodeId

The node’s identifier.

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 NodeAddr

pub fn new(node_id: PublicKey) -> Self

Creates a new NodeAddr with no relay_url and no direct_addresses.

pub fn with_relay_url(self, relay_url: RelayUrl) -> Self

Adds a relay url.

pub fn with_direct_addresses( self, addresses: impl IntoIterator<Item = SocketAddr>, ) -> Self

Adds the given direct addresses.

pub fn from_parts( node_id: PublicKey, relay_url: Option<RelayUrl>, direct_addresses: impl IntoIterator<Item = SocketAddr>, ) -> Self

Creates a new NodeAddr from its parts.

pub fn is_empty(&self) -> bool

Returns true, if only a NodeId is present.

pub fn direct_addresses(&self) -> impl Iterator<Item = &SocketAddr>

Returns the direct addresses of this peer.

pub fn relay_url(&self) -> Option<&RelayUrl>

Returns the relay url of this peer.

Trait Implementations

impl Clone for NodeAddr

fn clone(&self) -> NodeAddr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeAddr

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(PublicKey, Option<RelayUrl>, &[SocketAddr])> for NodeAddr

fn from(value: (PublicKey, Option<RelayUrl>, &[SocketAddr])) -> Self

Converts to this type from the input type.

impl From<NodeAddr> for NodeTicket

Available on crate feature ticket only.

fn from(addr: NodeAddr) -> Self

Creates a ticket from given addressing info.

impl From<NodeTicket> for NodeAddr

Available on crate feature ticket only.

fn from(ticket: NodeTicket) -> Self

Returns the addressing info from given ticket.

impl From<PublicKey> for NodeAddr

fn from(node_id: NodeId) -> Self

Converts to this type from the input type.

impl Ord for NodeAddr

fn cmp(&self, other: &NodeAddr) -> 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 NodeAddr

fn eq(&self, other: &NodeAddr) -> 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 NodeAddr

fn partial_cmp(&self, other: &NodeAddr) -> 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 NodeAddr

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NodeAddr

impl StructuralPartialEq for NodeAddr