Struct EndpointInfo 

pub struct EndpointInfo {
    pub endpoint_id: PublicKey,
    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: PublicKey

The EndpointId of the endpoint this is about.

data: EndpointData

The information published about the endpoint.

Implementations

impl EndpointInfo

pub fn new(endpoint_id: PublicKey) -> EndpointInfo

Creates a new EndpointInfo with an empty EndpointData.

pub fn from_parts(endpoint_id: PublicKey, data: EndpointData) -> EndpointInfo

Creates a new EndpointInfo from its parts.

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

Adds the relay URL and returns the updated endpoint info.

pub fn with_ip_addrs(self, addrs: Vec<SocketAddr>) -> EndpointInfo

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

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

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.

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

Returns the transport addr information.

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

Returns the relay URL of the endpoint.

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

Returns user data information, if set.

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

Returns the direct addresses of the endpoint.

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

Parses a EndpointInfo from DNS TXT lookup results.

The domain_name is the queried DNS name (e.g. _iroh.<z32>.<origin>). The lookup iterator yields TXT record values that implement Display.

pub fn from_pkarr_signed_packet( packet: &SignedPacket, ) -> Result<EndpointInfo, 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.

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

Formats the value using the given formatter.

impl Eq for EndpointInfo

impl From<EndpointAddr> for EndpointInfo

fn from(addr: EndpointAddr) -> EndpointInfo

Converts to this type from the input type.

impl From<EndpointInfo> for EndpointAddr

fn from(value: EndpointInfo) -> EndpointAddr

Converts to this type from the input type.

impl From<Item> for EndpointInfo

fn from(item: Item) -> EndpointInfo

Converts to this type from the input type.

impl PartialEq for EndpointInfo

fn eq(&self, other: &EndpointInfo) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EndpointInfo