Struct EndpointAddr 

pub struct EndpointAddr {
    pub id: EndpointId,
    pub addrs: BTreeSet<TransportAddr>,
}

Available on crate feature key only.

Network-level addressing information for an iroh endpoint.

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

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

• An Address Lookup service which can provide routing information for a given EndpointId.

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

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

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

Fields

id: EndpointId

The endpoint’s identifier.

addrs: BTreeSet<TransportAddr>

The endpoint’s addresses.

Implementations

impl EndpointAddr

pub fn new(id: PublicKey) -> Self

Creates a new EndpointAddr with no network level addresses.

This still is usable with e.g. an address lookup service to establish a connection, depending on the situation.

pub fn from_parts( id: PublicKey, addrs: impl IntoIterator<Item = TransportAddr>, ) -> Self

Creates a new EndpointAddr from its parts.

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

Adds a RelayUrl address.

pub fn with_ip_addr(self, addr: SocketAddr) -> Self

Adds an IP based address.

pub fn with_addrs(self, addrs: impl IntoIterator<Item = TransportAddr>) -> Self

Adds a list of addresses.

pub fn is_empty(&self) -> bool

Returns true if only an EndpointId is present.

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

Returns an iterator over the IP addresses of this endpoint address.

pub fn relay_urls(&self) -> impl Iterator<Item = &RelayUrl>

Returns an iterator over the relay URLs of this endpoint address.

In practice this is expected to be zero or one home relay for all known cases currently.

Trait Implementations

impl Clone for EndpointAddr

fn clone(&self) -> EndpointAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EndpointAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EndpointAddr

impl From<PublicKey> for EndpointAddr

fn from(endpoint_id: EndpointId) -> Self

Converts to this type from the input type.

impl Hash for EndpointAddr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EndpointAddr

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EndpointAddr