Struct EndpointData 

pub struct EndpointData { /* private fields */ }

Data about an endpoint that may be published to and resolved from discovery services.

This includes an optional RelayUrl, a set of direct addresses, and the optional UserData, a string that can be set by applications and is not parsed or used by iroh itself.

This struct does not include the endpoint’s EndpointId, only the data about a certain endpoint. See EndpointInfo for a struct that contains a EndpointId with associated EndpointData.

Implementations

impl EndpointData

pub fn new(addrs: Vec<TransportAddr>) -> Self

Creates a new EndpointData with given list of transport addresses.

The address order is preserved, so it can encode priority for address lookup services, should they not fit into e.g. a single DNS packet otherwise.

If the addresses contain duplicate entries, those entries are removed.

pub fn with_user_data(self, user_data: UserData) -> Self

Sets the user-defined data and returns the updated endpoint info.

Useful for calling on construction after EndpointData::new or EndpointData::from_iter.

See also Self::set_user_data.

pub fn add_relay_url(&mut self, relay_url: RelayUrl)

Adds the relay URL to the end of the endpoint data, unless it already existed.

pub fn add_ip_addrs(&mut self, addresses: Vec<SocketAddr>)

Adds addresses in order with duplicates or already existing addresses filtered out.

pub fn add_addrs(&mut self, addrs: impl IntoIterator<Item = TransportAddr>)

Adds addresses to the endpoint data in the given order, but with duplicates filtered.

pub fn set_user_data(&mut self, user_data: Option<UserData>)

Sets the user-defined data.

pub fn clear_ip_addrs(&mut self)

Removes all direct addresses from the endpoint data.

pub fn clear_relay_urls(&mut self)

Removes all relay URLs from the endpoint data.

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

Returns the relay URL of the endpoint.

pub fn user_data(&self) -> Option<&UserData>

Returns the optional user-defined data of the endpoint.

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

Returns the direct addresses of the endpoint.

pub fn addrs(&self) -> impl Iterator<Item = &TransportAddr>

Returns the full list of all known addresses.

pub fn has_addrs(&self) -> bool

Returns whether this has any addresses.

pub fn filtered_addrs(&self, filter: &AddrFilter) -> Cow<'_, Vec<TransportAddr>>

Apply the given filter to the current addresses.

Returns a vec to allow re-ordering of addresses.

pub fn apply_filter(&self, filter: &AddrFilter) -> Cow<'_, Self>

Returns the EndpointData with given filter applied.

Trait Implementations

impl Clone for EndpointData

fn clone(&self) -> EndpointData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointData

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

Formats the value using the given formatter.

impl Default for EndpointData

fn default() -> EndpointData

Returns the “default value” for a type.

impl From<BTreeSet<SocketAddr>> for EndpointData

fn from(addrs: BTreeSet<SocketAddr>) -> Self

Converts to this type from the input type.

impl From<BTreeSet<TransportAddr>> for EndpointData

fn from(addrs: BTreeSet<TransportAddr>) -> Self

Converts to this type from the input type.

impl From<EndpointAddr> for EndpointData

fn from(endpoint_addr: EndpointAddr) -> Self

Converts to this type from the input type.

impl FromIterator<TransportAddr> for EndpointData

fn from_iter<T: IntoIterator<Item = TransportAddr>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for EndpointData

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

impl StructuralPartialEq for EndpointData