Skip to main content

ModuleConfig

Struct ModuleConfig 

Source
pub struct ModuleConfig<'a> { /* private fields */ }
Expand description

Typed view over a Config for one module: prefixes every key with the module name in SCREAMING_SNAKE and parses values with defaults (issue #3).

use cratefield_core::{Config, ModuleConfig};
let cfg = MapConfig(
    [("EMAIL_SIGNUP_CONFIRM_TTL_DAYS".to_string(), "3".to_string())]
        .into_iter()
        .collect(),
);
let module = ModuleConfig::new("email-signup", &cfg);
assert_eq!(module.get_u32("CONFIRM_TTL_DAYS", 7), 3);
assert_eq!(module.get_bool("DOUBLE_OPT_IN", true), true);
assert_eq!(module.get_str("FROM_NAME", "Factory Zero"), "Factory Zero");

Implementations§

Source§

impl<'a> ModuleConfig<'a>

Source

pub fn new(module_name: &str, config: &'a dyn Config) -> Self

Source

pub fn key(&self, suffix: &str) -> String

The fully-qualified key for a module-suffix key.

Source

pub fn get_str(&self, key_suffix: &str, default: &str) -> String

Source

pub fn get_u32(&self, key_suffix: &str, default: u32) -> u32

Source

pub fn get_bool(&self, key_suffix: &str, default: bool) -> bool

Source

pub fn get_opt(&self, key_suffix: &str) -> Option<String>

An explicitly-set string key, None when absent.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ModuleConfig<'a>

§

impl<'a> !UnwindSafe for ModuleConfig<'a>

§

impl<'a> Freeze for ModuleConfig<'a>

§

impl<'a> Send for ModuleConfig<'a>

§

impl<'a> Sync for ModuleConfig<'a>

§

impl<'a> Unpin for ModuleConfig<'a>

§

impl<'a> UnsafeUnpin for ModuleConfig<'a>

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<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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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