Struct Configuration 

pub struct Configuration { /* private fields */ }

Represents a configuration.

Implementations

impl Configuration

pub fn new( settings: Settings, tokens: impl IntoIterator<Item = Box<dyn ChangeToken>>, providers: Vec<String>, ) -> Self

Initializes a new Configuration.

Arguments

• settings - The configuration settings
• tokens - The sequence of change tokens associated with the configuration
• providers - The names of the providers that generated the configuration

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

Gets a configuration value.

Arguments

• key - The case-insensitive key of the configuration value to get

pub fn section(&self, key: impl Into<String>) -> Section<'_>

Gets a section in this configuration.

Arguments

• key - The case-insensitive key of the configuration subsection to get

pub fn sections(&self) -> Vec<Section<'_>>

Gets all of the sections in this configuration.

pub fn change_token(&self) -> impl ChangeToken

Returns a change token that indicates when the configuration has changed.

Trait Implementations

impl Binder for Configuration

Available on crate feature binder only.

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

Creates and returns a structure reified from the configuration.

fn bind<T: DeserializeOwned>(&self, instance: &mut T) -> Result

Binds the configuration to the specified instance.

fn bind_at<T: DeserializeOwned>( &self, key: impl AsRef<str>, instance: &mut T, ) -> Result

Binds the specified configuration section to the provided instance.

fn get_value<T: FromStr>( &self, key: impl AsRef<str>, ) -> Result<Option<T>, T::Err>

Gets a typed value from the configuration.

fn get_value_or_default<T: FromStr + Default>( &self, key: impl AsRef<str>, ) -> Result<T, T::Err>

Gets an optional, typed value from the configuration.

fn reify_unchecked<T: DeserializeOwned>(&self) -> T

Creates and returns a structure reified from the configuration.

fn bind_unchecked<T: DeserializeOwned>(&self, instance: &mut T)

Binds the configuration to the specified instance.

fn bind_at_unchecked<T: DeserializeOwned>( &self, key: impl AsRef<str>, instance: &mut T, )

Binds the specified configuration section to the provided instance.

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Display for Configuration

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

Formats the value using the given formatter.

impl<'a> From<&'a Configuration> for Vec<Section<'a>>

fn from(config: &'a Configuration) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Configuration

type Item = (&'a str, &'a str)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Configuration

type Item = (String, String)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Merge<Configuration> for Settings

fn merge(&mut self, other: &Configuration)

Merges an object into current object.

impl Merge<Settings> for Configuration

fn merge(&mut self, other: &Settings)

Merges an object into current object.

impl Merge for Configuration

fn merge(&mut self, other: &Self)

Merges an object into current object.

impl Reloadable for Configuration

fn can_reload(&self) -> bool

Gets a value indicating whether the configuration can be reloaded.

fn reload_token(&self) -> impl ChangeToken + 'static

Gets a change token that will be notified when the configuration is reloaded.

impl TryFrom<Builder> for Configuration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(builder: Builder) -> Result<Self>

Performs the conversion.