Struct ConfigFile

pub struct ConfigFile { /* private fields */ }

Wrapper for file-based ConfigLayer, providing convenient methods for modification.

Implementations

impl ConfigFile

pub fn load_or_empty( source: ConfigSource, path: impl Into<PathBuf>, ) -> Result<Self, ConfigLoadError>

Loads TOML file from the specified path if exists. Returns an empty object if the file doesn’t exist.

pub fn from_layer(layer: Arc<ConfigLayer>) -> Result<Self, Arc<ConfigLayer>>

Wraps file-based ConfigLayer for modification. Returns Err(layer) if the source path is unknown.

pub fn save(&self) -> Result<(), ConfigFileSaveError>

Writes serialized data to the source file.

pub fn path(&self) -> &Path

Source file path.

pub fn layer(&self) -> &Arc<ConfigLayer>

Returns the underlying config layer.

pub fn set_value( &mut self, name: impl ToConfigNamePath, new_value: impl Into<ConfigValue>, ) -> Result<Option<ConfigValue>, ConfigUpdateError>

See ConfigLayer::set_value().

pub fn delete_value( &mut self, name: impl ToConfigNamePath, ) -> Result<Option<ConfigValue>, ConfigUpdateError>

See ConfigLayer::delete_value().

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.