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: impl IntoIterator<Item = TransportAddr>) -> EndpointData

Creates a new EndpointData with a relay URL and a set of direct addresses.

pub fn with_relay_url(self, relay_url: Option<RelayUrl>) -> EndpointData

Sets the relay URL and returns the updated endpoint data.

pub fn with_ip_addrs(self, addresses: BTreeSet<SocketAddr>) -> EndpointData

Sets the direct addresses and returns the updated endpoint data.

pub fn with_user_data(self, user_data: Option<UserData>) -> EndpointData

Sets the user-defined data and returns the updated 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 clear_ip_addrs(&mut self)

Removes all direct addresses from the endpoint data.

pub fn clear_relay_urls(&mut self)

Removes all direct addresses from the endpoint data.

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

Add addresses to the endpoint data.

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

Sets the user-defined data of the endpoint data.

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

Returns the full list of all known addresses

pub fn has_addrs(&self) -> bool

Does this have any addresses?

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<(), Error>

Formats the value using the given formatter.

impl Default for EndpointData

fn default() -> EndpointData

Returns the “default value” for a type.

impl From<EndpointAddr> for EndpointData

fn from(endpoint_addr: EndpointAddr) -> EndpointData

Converts to this type from the input type.

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