Struct RelayMap 

pub struct RelayMap { /* private fields */ }

List of relay server configurations to be used in an iroh endpoint.

A RelayMap can be constructed from an iterator of RelayConfig or [RelayUrl], or by creating an empty relay map with RelayMap::empty and then adding entries with RelayMap::insert.

Example:

let relay1 = RelayUrl::from_str("https://relay1.example.org").unwrap();
let relay2 = RelayUrl::from_str("https://relay2.example.org").unwrap();
let map = RelayMap::from_iter(vec![relay1, relay2]);

Implementations

impl RelayMap

pub fn empty() -> Self

Creates an empty relay map.

pub fn try_from_iter<'a, T: IntoIterator<Item = &'a str>>( urls: T, ) -> Result<Self, RelayUrlParseError>

Creates a RelayMap from an iterator.

The conversion from a URL to a RelayConfig is done the same as when parsing it directly, which means it is assumed to run QUIC on default settings as defined in RelayQuicConfig::default.

Example

let map =
    RelayMap::try_from_iter(["https://relay_0.cool.com", "https://relay_1.cool.com"]).unwrap();

pub fn urls<T>(&self) -> T

where T: FromIterator<RelayUrl>,

Returns the URLs of all servers in this relay map.

This function is generic over the container to collect into. If you simply want a list of URLs, call this with map.urls::<Vec<_>>() to get a Vec<RelayUrl>.

pub fn relays<T>(&self) -> T

where T: FromIterator<Arc<RelayConfig>>,

Returns a list with the RelayConfig for each relay in this relay map.

This function is generic over the container to collect into. If you simply want a list of URLs, call this with map.relays::<Vec<_>>() to get a Vec<RelayConfig>.

pub fn contains(&self, url: &RelayUrl) -> bool

Returns true if a relay with url is contained in this this relay map.

pub fn get(&self, url: &RelayUrl) -> Option<Arc<RelayConfig>>

Returns the config for a relay.

pub fn len(&self) -> usize

Returns the number of relays in this relay map.

pub fn is_empty(&self) -> bool

Returns true if this relay map is empty.

pub fn insert( &self, url: RelayUrl, endpoint: Arc<RelayConfig>, ) -> Option<Arc<RelayConfig>>

Inserts a new relay into the relay map.

pub fn remove(&self, url: &RelayUrl) -> Option<Arc<RelayConfig>>

Removes an existing relay by its URL.

pub fn extend(&self, other: &RelayMap)

Extends this RelayMap with another one.

pub fn with_auth_token(self, auth_token: impl Into<String>) -> Self

Sets an authorization token for all relays configured in this relay map.

This applies RelayConfig::with_auth_token to all current entries in this relay map. Any entries added to this relay map after calling this will not have the token set.

See RelayConfig::with_auth_token for details.

Trait Implementations

impl Clone for RelayMap

fn clone(&self) -> RelayMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayMap

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

Formats the value using the given formatter.

impl Display for RelayMap

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

Formats the value using the given formatter.

impl Eq for RelayMap

impl From<RelayConfig> for RelayMap

fn from(value: RelayConfig) -> Self

Converts to this type from the input type.

impl From<RelayUrl> for RelayMap

fn from(value: RelayUrl) -> Self

Creates a RelayMap from a RelayUrl.

The RelayConfigs in the RelayMap will have the default QUIC address discovery ports.

impl FromIterator<Arc<RelayConfig>> for RelayMap

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

Creates a value from an iterator.

impl FromIterator<RelayConfig> for RelayMap

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

Creates a value from an iterator.

impl FromIterator<RelayUrl> for RelayMap

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

Creates a RelayMap from an iterator of RelayUrl.

The RelayConfigs in the RelayMap will have the default QUIC address discovery ports.

impl PartialEq for RelayMap

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

Equality operator ==.

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

Inequality operator !=.