Struct Section 

pub struct Section<'a> { /* private fields */ }

Represents a configuration section.

Implementations

impl<'a> Section<'a>

pub fn section(&self, key: &str) -> Section<'a>

Gets a configuration subsection in this section.

Arguments

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

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

Gets all of the subsections in this section.

pub fn to_owned(&self) -> OwnedSection

Gets an owned copy of the section.

Remarks

This function is useful for taking ownership of a section in order to decouple it from the entire configuration that created it. The owned section holds a reference to the subset of key/value pairs at this point in the configuration.

pub fn key(&self) -> &str

Gets the key of the section.

pub fn path(&self) -> &str

Gets the path of the section.

pub fn value(&self) -> &str

Gets the value of the section, if any.

pub fn exists(&self) -> bool

Determines if the section exists.

Remarks

A section exists if either its value or its subsections are not empty.

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

Gets a configuration value in this section.

Arguments

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

Trait Implementations

impl Binder for Section<'_>

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<'a> Clone for Section<'a>

fn clone(&self) -> Section<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section<'_>

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

Formats the value using the given formatter.

impl Display for Section<'_>

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

Formats the value using the given formatter.

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

fn from(section: &'a Section<'a>) -> Self

Converts to this type from the input type.

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

fn from(section: Section<'a>) -> Self

Converts to this type from the input type.

impl Reloadable for Section<'_>

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.