Struct ConfigMut

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

Mutable reference to a specific configuration inside ConfigSchema.

Implementations

impl ConfigMut<'_>

pub fn prefix(&self) -> &str

Gets the config prefix.

pub fn aliases(&self) -> impl Iterator<Item = (&str, AliasOptions)> + '_

Iterates over all aliases for this config.

pub fn push_alias(self, alias: &'static str) -> Result<Self>

Pushes an additional alias for the config.

Errors

Returns an error if adding a config leads to violations of fundamental invariants (same as for ConfigSchema::insert()).

pub fn push_deprecated_alias(self, alias: &'static str) -> Result<Self>

Same as Self::push_alias(), but also marks the alias as deprecated.

Errors

Returns an error if adding a config leads to violations of fundamental invariants (same as for ConfigSchema::insert()).

Trait Implementations

impl<'a> Debug for ConfigMut<'a>

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

Formats the value using the given formatter.