Skip to main content

ConfigLayer

Enum ConfigLayer 

Source
pub enum ConfigLayer {
    File(PathBuf),
    EnvPrefix(String),
    Overrides(BTreeMap<String, Value>),
}
Expand description

One named source of configuration values.

Layers are applied by ConfigBuilder::layer in the order they are added. A later layer’s keys replace earlier ones, while tables merge key-by-key (deep merge), so a late layer can override a single nested field without clobbering its siblings. Driven in the documented order this yields precedence overrides > env > file.

Variants§

§

File(PathBuf)

A configuration file, parsed at load time by extension: .json (feature json), .yaml/.yml (feature yaml), and anything else — including no extension — as TOML.

§

EnvPrefix(String)

All environment variables sharing a prefix. The prefix is stripped and the remainder lowercased to form the top-level key; values are typed by inference (see the crate root for the exact rules).

§

Overrides(BTreeMap<String, Value>)

In-process values, typically assembled by a supervisor or test. Applied last in the documented order, hence highest precedence.

Implementations§

Source§

impl ConfigLayer

Source

pub fn file(path: impl AsRef<Path>) -> Self

A file-backed layer parsed by extension (TOML core; JSON and YAML behind the matching features).

Source

pub fn env_prefix(prefix: impl Into<String>) -> Self

An environment layer matching every variable that starts with prefix (case-sensitive).

Source

pub fn overrides(overrides: BTreeMap<String, Value>) -> Self

An in-process override layer keyed by top-level field name.

Trait Implementations§

Source§

impl Clone for ConfigLayer

Source§

fn clone(&self) -> Self

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 ConfigLayer

Source§

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

Formats the value using the given formatter. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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.