Struct RelayConfig 

#[non_exhaustive]
pub struct RelayConfig {
    pub http_bind_addr: SocketAddr,
    pub tls: Option<TlsConfig>,
    pub limits: Limits,
    pub key_cache_capacity: Option<usize>,
    pub access: Arc<dyn DynAccessControl>,
}

Available on crate feature server only.

Configuration for the Relay HTTP and HTTPS server.

This includes the HTTP services hosted by the Relay server, the Relay /relay HTTP endpoint is only one of the services served.

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.

http_bind_addr: SocketAddr

The socket address on which the Relay HTTP server should bind.

Normally you’d choose port 80. The bind address for the HTTPS server is configured in RelayConfig::tls.

If RelayConfig::tls is None then this serves all the HTTP services without TLS.

tls: Option<TlsConfig>

TLS configuration for the HTTPS server.

If None all the HTTP services that would be served here are served from RelayConfig::http_bind_addr.

limits: Limits

Rate limits.

key_cache_capacity: Option<usize>

Key cache capacity.

access: Arc<dyn DynAccessControl>

Access control for incoming connections.

Implementations

impl RelayConfig

pub fn new(http_bind_addr: impl Into<SocketAddr>) -> Self

Creates a new RelayConfig bound to http_bind_addr with default settings.

TLS is disabled, default Limits are used, the key cache capacity is unset, and access defaults to AllowAll. Adjust any of these by assigning to the corresponding fields after construction.

Trait Implementations

impl Debug for RelayConfig

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

Formats the value using the given formatter.