Struct Config 

pub struct Config {
    pub server: Server,
    pub auth: Auth,
    pub limits: Limits,
    pub security: Security,
    pub log: Log,
}

The complete server configuration.

Fields

server: Server

Listener, certificate and ALPN settings.

auth: Auth

Credentials accepted on CONNECT requests.

limits: Limits

Resource limits.

security: Security

Destination policy and abuse mitigations.

log: Log

Logging settings.

Implementations

impl Config

pub fn load(path: &Path) -> Result<Self>

Reads and validates the configuration at path.

A parse failure is rendered by parse_error rather than carried in the error chain, because this file holds passwords and the toml crate’s own Display prints the offending source line.

pub fn validate(&self) -> Result<()>

Checks everything that TOML deserialization cannot express.

Every error names the offending field so the operator does not have to guess which key is wrong. Checks are ordered cheapest first, so a syntactic mistake is reported without touching the filesystem.

impl Config

pub fn warnings(&self) -> Vec<String>

Settings that are legal but that an operator should be told about.

Returned rather than logged so the caller can emit them after the tracing subscriber exists — a warning logged during load() would be written to a subscriber that has not been installed yet, i.e. nowhere — and so they can be asserted on in tests.

This opens and parses server.cert when security.expected_sni is not empty, so it is a blocking file read and not only a walk over the parsed configuration. ReloadHandle::reload calls it before it takes the ConfigSwap guard for that reason.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.