Struct RelayAddress 

pub struct RelayAddress {
    pub public_key: VerifyingKey,
    pub addresses: BTreeSet<NetworkAddress>,
    pub name: Option<String>,
}

Relay address information for a service

Contains the public key and network addresses needed to connect to a service. This structure is designed to be compact and suitable for QR code encoding.

Fields

public_key: VerifyingKey

Public key of the service

Used to verify the service’s identity during the connection handshake. This prevents man-in-the-middle attacks and ensures the client is connecting to the correct service. Supports Ed25519 and ML-DSA keys.

addresses: BTreeSet<NetworkAddress>

Network addresses where the service can be reached

Multiple addresses can be provided for redundancy and different network configurations. Clients should try addresses in order until one succeeds.

name: Option<String>

Optional human-readable name for the service

Can be used for display purposes or debugging. Examples: “Primary Relay”, “EU West”, “Backup Server”, etc.

Implementations

impl RelayAddress

pub fn new(public_key: VerifyingKey) -> Self

Create a new connection info with minimal required fields

pub fn with_address(self, address: NetworkAddress) -> Self

Add a network address

pub fn with_address_str(self, address: String) -> Self

pub fn with_addresses( self, addresses: impl IntoIterator<Item = NetworkAddress>, ) -> Self

Add multiple network addresses

pub fn with_name(self, name: impl Into<String>) -> Self

Set a human-readable name for this service

pub fn display_name(&self) -> String

Get the service’s display name (name if set, otherwise first address)

pub fn addresses_with_port(&self, port: u16) -> Vec<NetworkAddress>

Get all addresses that use the specified port (or default port)

pub fn primary_address(&self) -> Option<&NetworkAddress>

Get the first address, if any

pub fn id(&self) -> KeyId

Get the relay ID (public key ID)

pub fn all_addresses(&self) -> &BTreeSet<NetworkAddress>

Get all addresses for connection attempts

Trait Implementations

impl Clone for RelayAddress

fn clone(&self) -> RelayAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelayAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RelayAddress

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RelayAddress

impl StructuralPartialEq for RelayAddress