pub struct DefaultConfigurationRoot { /* private fields */ }
Available on crate feature
std
only.Expand description
Represents the root of a configuration.
Implementations§
Source§impl DefaultConfigurationRoot
impl DefaultConfigurationRoot
Sourcepub fn new(
providers: Vec<Box<dyn ConfigurationProvider>>,
) -> Result<Self, ReloadError>
pub fn new( providers: Vec<Box<dyn ConfigurationProvider>>, ) -> Result<Self, ReloadError>
Initializes a new root configuration.
§Arguments
providers
- TheConfigurationProvider
list used in the configuration
Trait Implementations§
Source§impl<'a> AsRef<dyn Configuration + 'a> for DefaultConfigurationRoot
impl<'a> AsRef<dyn Configuration + 'a> for DefaultConfigurationRoot
Source§fn as_ref(&self) -> &(dyn Configuration + 'a)
fn as_ref(&self) -> &(dyn Configuration + 'a)
Converts this type into a shared reference of the (usually inferred) input type.
Source§impl<'a> Borrow<dyn Configuration + 'a> for DefaultConfigurationRoot
impl<'a> Borrow<dyn Configuration + 'a> for DefaultConfigurationRoot
Source§fn borrow(&self) -> &(dyn Configuration + 'a)
fn borrow(&self) -> &(dyn Configuration + 'a)
Immutably borrows from an owned value. Read more
Source§impl Clone for DefaultConfigurationRoot
impl Clone for DefaultConfigurationRoot
Source§fn clone(&self) -> DefaultConfigurationRoot
fn clone(&self) -> DefaultConfigurationRoot
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Configuration for DefaultConfigurationRoot
impl Configuration for DefaultConfigurationRoot
Source§fn section(&self, key: &str) -> Box<dyn ConfigurationSection>
fn section(&self, key: &str) -> Box<dyn ConfigurationSection>
Gets a
ConfigurationSection
with the specified key.Source§fn children(&self) -> Vec<Box<dyn ConfigurationSection>>
fn children(&self) -> Vec<Box<dyn ConfigurationSection>>
Gets the sequence of
ConfigurationSection
children.Source§fn reload_token(&self) -> Box<dyn ChangeToken>
fn reload_token(&self) -> Box<dyn ChangeToken>
Returns a
ChangeToken
that can be used to observe when this configuration is reloaded.Source§fn iter(
&self,
path: Option<ConfigurationPath>,
) -> Box<dyn Iterator<Item = (String, Value)>>
fn iter( &self, path: Option<ConfigurationPath>, ) -> Box<dyn Iterator<Item = (String, Value)>>
Gets an iterator of the key/value pairs within the
Configuration
. Read moreSource§fn as_section(&self) -> Option<&dyn ConfigurationSection>
fn as_section(&self) -> Option<&dyn ConfigurationSection>
Attempts to convert the
Configuration
as a ConfigurationSection
.Source§impl ConfigurationRoot for DefaultConfigurationRoot
impl ConfigurationRoot for DefaultConfigurationRoot
Source§fn reload(&mut self) -> ReloadResult
fn reload(&mut self) -> ReloadResult
Force the configuration values to be reloaded from the underlying
ConfigurationProvider
collection.Source§fn providers(&self) -> Box<dyn ConfigurationProviderIterator<'_> + '_>
fn providers(&self) -> Box<dyn ConfigurationProviderIterator<'_> + '_>
Gets the
ConfigurationProvider
sequence for this configuration.Source§fn as_config(&self) -> Box<dyn Configuration>
fn as_config(&self) -> Box<dyn Configuration>
Converts the
ConfigurationRoot
into a Configuration
.Source§impl Debug for DefaultConfigurationRoot
impl Debug for DefaultConfigurationRoot
Auto Trait Implementations§
impl Freeze for DefaultConfigurationRoot
impl !RefUnwindSafe for DefaultConfigurationRoot
impl !Send for DefaultConfigurationRoot
impl !Sync for DefaultConfigurationRoot
impl Unpin for DefaultConfigurationRoot
impl !UnwindSafe for DefaultConfigurationRoot
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<C> ConfigurationBinder for Cwhere
C: AsRef<dyn Configuration>,
impl<C> ConfigurationBinder for Cwhere
C: AsRef<dyn Configuration>,
Source§fn reify<T>(&self) -> Twhere
T: DeserializeOwned,
fn reify<T>(&self) -> Twhere
T: DeserializeOwned,
Creates and returns a structure bound to the configuration.
Source§fn bind<T>(&self, instance: &mut T)where
T: DeserializeOwned,
fn bind<T>(&self, instance: &mut T)where
T: DeserializeOwned,
Binds the configuration to the specified instance. Read more
Source§fn bind_at<T>(&self, key: impl AsRef<str>, instance: &mut T)where
T: DeserializeOwned,
fn bind_at<T>(&self, key: impl AsRef<str>, instance: &mut T)where
T: DeserializeOwned,
Binds the specified configuration section to the provided instance. Read more