Struct RawConfig

pub struct RawConfig(/* private fields */);

Offers utility functions for editing the configuration. Validates on write.

Implementations

impl RawConfig

pub fn from_file(path: &Path) -> Result<RawConfig, WriteError>

Creates a temporary configuration, by reading a configuration file from disk.

pub fn get_mut(&mut self, config_path: &ConfigPath) -> Option<&mut Value>

Get a mutable reference to a configuration value by path, if it exists.

pub fn unset(&mut self, config_path: &ConfigPath) -> Result<Value, ModifyError>

Delete the specified path.

pub fn push( &mut self, config_path: &ConfigPath, value: ConfigValue, ) -> Result<Value, ModifyError>

pub fn remove( &mut self, config_path: &ConfigPath, value: ConfigValue, ) -> Result<Value, ModifyError>

pub fn set( &mut self, config_path: &ConfigPath, value: ConfigValue, ) -> Result<Value, ModifyError>

pub fn write(&self, path: &Path) -> Result<(), WriteError>

Writes the configuration, including extra values, to disk. Errors if the config is not valid.

Trait Implementations

impl Clone for RawConfig

fn clone(&self) -> RawConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawConfig

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

Formats the value using the given formatter.

impl TryFrom<RawConfig> for Config

type Error = Error

The type returned in the event of a conversion error.

fn try_from( raw: RawConfig, ) -> Result<Config, <Config as TryFrom<RawConfig>>::Error>

Performs the conversion.