Struct RelayConfig 

pub struct RelayConfig {
    pub bind: SocketAddr,
    pub enroll_token: String,
    pub rate_limit: RateLimitConfig,
    pub public_base: Option<String>,
}

Relay server settings.

Fields

bind: SocketAddr

Address to listen on.

enroll_token: String

Secret a device must present to attach.

rate_limit: RateLimitConfig

Per-IP request limiting for this relay.

The relay is the only place this can work for proxied traffic: a device replays requests to its own loopback listener, so its limiter sees 127.0.0.1 for every caller and cannot tell them apart. Here the real client address is still visible.

public_base: Option<String>

Public base URL of this relay, when the operator states it explicitly.

Left unset, the relay derives it from each connection’s Host (and X-Forwarded-*) headers, so a relay behind TLS termination still tells devices an address that actually works.

Implementations

impl RelayConfig

pub fn new(bind: SocketAddr, enroll_token: impl Into<String>) -> Self

Create a configuration with the given bind address and token.

pub fn without_rate_limit(self) -> Self

Turn per-IP request limiting off.

pub fn with_public_base(self, base: impl Into<String>) -> Self

Set the public base URL advertised to devices.

pub fn resolved_public_base(&self) -> Option<String>

The operator-configured base with this relay’s listen port filled in when the base named no port.

A base written without a port (https://relay.example.com) means the scheme default to a browser, but an operator who bound 8443 and named no proxy meant this relay — so the listen port is the least-surprising fill, and every advertised URL then reaches something. An explicit port is intent and is left untouched, which is how a reverse proxy on 443 keeps a port-less base. observed bases are never touched here: they already name a reachable authority.

pub fn public_base_or(&self, observed: Option<String>) -> String

The base URL to advertise, preferring what the operator configured.

observed is what the connection itself says this relay is reachable at. Falling back to the bind address is a last resort — it is right only when nothing is in front of the relay.

pub fn public_url_for( &self, device_id: &str, observed: Option<String>, ) -> String

Public URL that routes to device_id.

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.