Struct irx_config::config::Config

pub struct Config { /* private fields */ }

Container for all parser sources which will (re)load data from a parsers in order in which they was added to ConfigBuilder. It will provide access to merged set of (re)loaded configuration parameters.

Implementations

impl Config

pub fn reload(&mut self) -> Result<&mut Self>

Reload and re-merge all configuration data from parsers.

Errors

If any errors will occur during parsing/merging then error will be returned.

pub fn hash(&self) -> String

Calculate hash for currently loaded configuration data.

pub fn get_by_keys<I, K, T>(&self, keys: I) -> Result<Option<T>>

where I: IntoIterator<Item = K>, K: AsRef<str>, T: DeserializeOwned,

Returns configuration data value to corresponding key/nested keys.

Example

let name: Option<u32> = conf.get_by_keys(["logger", "name"])?;

Errors

If keys is empty, the error will be returned.

pub fn get_by_key_path<T, P>(&self, path: P) -> Result<Option<T>>

where T: DeserializeOwned, P: AsRef<str>,

Returns configuration data value to corresponding key path with keys delimiter. Default delimiter is DEFAULT_KEYS_SEPARATOR.

Example

use serde::Deserialize;

#[derive(Deserialize)]
struct Person {
    first_name: String,
    last_name: String,
    age: u8,
}

let person: Option<Person> = conf.get_by_key_path("contact:info")?;

Errors

If keys path or keys delimiter is empty, the corresponding error will be returned.

pub fn get_by_key_path_with_delim<T, P, D>( &self, path: P, delim: D ) -> Result<Option<T>>

where T: DeserializeOwned, P: AsRef<str>, D: AsRef<str>,

Returns configuration data value to corresponding key path with delimiter.

Example

let name: Option<u32> = conf.get_by_key_path_with_delim("logger:name", ":")?;

Errors

If keys path or delimiter is empty, the corresponding error will be returned.

pub fn get<T: DeserializeOwned>(&self) -> Result<T>

Deserialize configuration to destination struct/value.

Example

use serde::Deserialize;

#[derive(Deserialize)]
struct Person {
    first_name: String,
    last_name: String,
    age: u8,
}

let person: Person = conf.get()?;

Errors

In case of any de-serialization problems the corresponding error will be returned.

pub fn get_value(&self) -> &Value

Get reference to internal Value structure.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Display for Config

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

Formats the value using the given formatter.

impl Ord for Config

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Config

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Config

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Config