Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

A merged configuration, and where each of its values came from.

Implementations§

Source§

impl Config

Source

pub fn root(&self) -> Option<&Node>

The merged tree, or None when nothing was loaded.

Source

pub fn sources(&self) -> &[String]

Every file that contributed, in the order it was read.

Source

pub fn get(&self, path: &str) -> Option<&Node>

The node at a dotted path.

Source

pub fn get_str(&self, path: &str) -> Option<&str>

The scalar at a dotted path.

Source

pub fn origin_of(&self, path: &str) -> Option<&Origin>

Where the value at a dotted path came from.

This is the question a layered configuration exists to answer.

Source

pub fn push(&mut self, node: Node, source: String) -> Result<(), ConfigError>

Merges one more source in, after everything already there. A refused layer leaves both the effective tree and source list unchanged.

§Errors

Whatever Node::merge reports.

Source

pub fn push_each( &mut self, nodes: Vec<Node>, source: String, ) -> Result<(), ConfigError>

Merges several trees in, one after another, as one source. Each tree’s +name appends to what the ones before it left, which one pre-merged tree could not express. All or nothing, like Self::push.

§Errors

Whatever Node::merge reports.

Trait Implementations§

Source§

impl Clone for Config

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 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() -> Self

Returns the “default value” for a type. 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.