Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub server: ServerSection,
    pub tls: Option<TlsSection>,
}
Expand description

The fully-resolved application configuration.

Deserializes from a churust.toml file (with a [server] table and an optional [tls] table) and can be overlaid with CHURUST_* environment variables via apply_env. Apply it to a builder with AppBuilder::with_config, or use Churust::from_config to load and apply the defaults in one step. Unspecified fields fall back to sane defaults.

use churust_core::Config;

let cfg: Config = toml::from_str(r#"
    [server]
    host = "0.0.0.0"
    port = 9090
"#).unwrap();
assert_eq!(cfg.server.host, "0.0.0.0");
assert_eq!(cfg.server.port, 9090);
// unspecified fields keep their defaults
assert_eq!(cfg.server.max_body_bytes, 1 << 20);
assert!(cfg.tls.is_none());

Fields§

§server: ServerSection

Server-level settings ([server] table).

§tls: Option<TlsSection>

Optional TLS settings ([tls] table); None serves plaintext HTTP.

Implementations§

Source§

impl Config

Source

pub fn load(path: &str) -> Self

Load configuration by layering, in increasing precedence: built-in defaults, then the TOML file at path (if it exists and parses), then CHURUST_* environment variables.

A missing or unparseable file is treated as “use defaults” rather than an error, so calling this without a config file present is safe.

use churust_core::Config;
// Reads ./my-app.toml if present, then applies CHURUST_* env overrides.
let cfg = Config::load("my-app.toml");
let _ = cfg.server.port;
Source

pub fn load_default() -> Self

Load configuration from the conventional churust.toml path (plus CHURUST_* env overrides). A shorthand for Config::load("churust.toml"); this is what Churust::from_config uses.

use churust_core::Config;
let cfg = Config::load_default();
let _ = cfg.server.host;
Source

pub fn apply_env(&mut self, get: impl Fn(&str) -> Option<String>)

Overlay CHURUST_* environment variables onto this config, using the provided get lookup so the source can be injected in tests.

Recognized keys: CHURUST_SERVER_HOST, CHURUST_SERVER_PORT, CHURUST_SERVER_MAX_BODY_BYTES, CHURUST_SERVER_REQUEST_TIMEOUT_MS. Values that fail to parse (e.g. a non-numeric port) are ignored, leaving the existing value in place.

use churust_core::Config;
use std::collections::HashMap;

let env: HashMap<&str, &str> = [("CHURUST_SERVER_PORT", "7000")].into_iter().collect();
let mut cfg = Config::default();
cfg.apply_env(|k| env.get(k).map(|s| s.to_string()));
assert_eq!(cfg.server.port, 7000);

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config
where Config: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more