Struct RelayMap

pub struct RelayMap { /* private fields */ }

Available on crate feature relay only.

Configuration of all the relay servers that can be used.

Implementations

impl RelayMap

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

Returns the sorted relay URLs.

pub fn empty() -> Self

Create an empty relay map.

pub fn nodes(&self) -> impl Iterator<Item = &Arc<RelayNode>>

Returns an Iterator over all known nodes.

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

Is this a known node?

pub fn get_node(&self, url: &RelayUrl) -> Option<&Arc<RelayNode>>

Get the given node.

pub fn len(&self) -> usize

How many nodes are known?

pub fn is_empty(&self) -> bool

Are there any nodes in this map?

pub fn default_from_node(url: RelayUrl, stun_port: u16) -> Self

Creates a new RelayMap with a single relay server configured.

Allows to set a custom STUN port and different IP addresses for IPv4 and IPv6. If IP addresses are provided, no DNS lookup will be performed.

Sets the port to the default DEFAULT_RELAY_QUIC_PORT.

pub fn from_url(url: RelayUrl) -> Self

Returns a RelayMap from a RelayUrl.

This will use the default STUN port, the default QUIC port (as defined by the iroh-relay crate) and IP addresses resolved from the URL’s host name via DNS. relay nodes are specified at <../../docs/relay_nodes.md>

pub fn from_nodes<I: Into<Arc<RelayNode>>>( value: impl IntoIterator<Item = I>, ) -> Result<Self>

Constructs the RelayMap from an iterator of RelayNodes.

Trait Implementations

impl Clone for RelayMap

fn clone(&self) -> RelayMap

Returns a copy 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 PartialEq for RelayMap

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

impl StructuralPartialEq for RelayMap