Struct RelayConfig 

#[non_exhaustive]
pub struct RelayConfig {
    pub url: RelayUrl,
    pub quic: Option<RelayQuicConfig>,
    pub auth_token: Option<String>,
}

Information on a specific relay server.

Includes the Url where it can be dialed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: RelayUrl

The RelayUrl where this relay server can be dialed.

quic: Option<RelayQuicConfig>

Configuration to speak to the QUIC endpoint on the relay server.

When None, we will not attempt to do QUIC address discovery with this relay server.

auth_token: Option<String>

Optional authorization token sent to the relay.

Set via RelayConfig::with_auth_token.

Implementations

impl RelayConfig

pub fn new(url: RelayUrl, quic: Option<RelayQuicConfig>) -> Self

Creates a new relay configuration with the given URL and optional QUIC config.

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

Sets an authorization token for this relay.

On native targets, the token is sent as an Authorization: Bearer TOKEN header on the WebSocket upgrade request.

When compiled to WebAssembly the token is sent as a ?token=TOKEN query parameter on the upgrade URL, since browsers don’t allow setting headers on WebSocket requests.

Trait Implementations

impl Clone for RelayConfig

fn clone(&self) -> RelayConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelayConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelayConfig

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

Formats the value using the given formatter.

impl Eq for RelayConfig

impl From<RelayConfig> for RelayMap

fn from(value: RelayConfig) -> Self

Converts to this type from the input type.

impl From<RelayUrl> for RelayConfig

fn from(value: RelayUrl) -> Self

Converts to this type from the input type.

impl FromIterator<RelayConfig> for RelayMap

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

Creates a value from an iterator.

impl Ord for RelayConfig

fn cmp(&self, other: &RelayConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RelayConfig

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RelayConfig

fn partial_cmp(&self, other: &RelayConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RelayConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RelayConfig