Struct EndpointInfo 

pub struct EndpointInfo {
    pub endpoint_id: EndpointId,
    pub data: EndpointData,
}

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

This struct couples a EndpointId with its associated EndpointData.

Fields

endpoint_id: EndpointId

The EndpointId of the endpoint this is about.

data: EndpointData

The information published about the endpoint.

Implementations

impl EndpointInfo

pub fn new(endpoint_id: EndpointId) -> Self

Creates a new EndpointInfo with an empty EndpointData.

pub fn from_parts(endpoint_id: EndpointId, data: EndpointData) -> Self

Creates a new EndpointInfo from its parts.

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

Sets the relay URL and returns the updated endpoint info.

pub fn with_ip_addrs(self, addrs: BTreeSet<SocketAddr>) -> Self

Sets the IP based addresses and returns the updated endpoint info.

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

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

pub fn to_endpoint_addr(&self) -> EndpointAddr

Converts into a EndpointAddr by cloning the needed fields.

pub fn into_endpoint_addr(self) -> EndpointAddr

Converts into a EndpointAddr without cloning.

pub fn from_txt_lookup( domain_name: String, lookup: impl Iterator<Item = TxtRecordData>, ) -> Result<Self, ParseError>

Available on non-wasm_browser only.

Parses a EndpointInfo from DNS TXT lookup.

pub fn from_pkarr_signed_packet( packet: &SignedPacket, ) -> Result<Self, ParseError>

Parses a EndpointInfo from a [pkarr::SignedPacket].

pub fn to_pkarr_signed_packet( &self, secret_key: &SecretKey, ttl: u32, ) -> Result<SignedPacket, EncodingError>

Creates a [pkarr::SignedPacket].

This constructs a DNS packet and signs it with a SecretKey.

pub fn to_txt_strings(&self) -> Vec<String>

Converts into a list of {key}={value} strings.

Methods from Deref<Target = EndpointData>

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 EndpointInfo

fn clone(&self) -> EndpointInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointInfo

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

Formats the value using the given formatter.

impl Deref for EndpointInfo

type Target = EndpointData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for EndpointInfo

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<EndpointAddr> for EndpointInfo

fn from(addr: EndpointAddr) -> Self

Converts to this type from the input type.

impl From<EndpointInfo> for EndpointAddr

fn from(value: EndpointInfo) -> Self

Converts to this type from the input type.

impl PartialEq for EndpointInfo

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

impl StructuralPartialEq for EndpointInfo