Struct ConfigLayer

pub struct ConfigLayer {
    pub source: ConfigSource,
    pub path: Option<PathBuf>,
    pub data: DocumentMut,
}

Set of configuration variables with source information.

Fields

source: ConfigSource

Source type of this layer.

path: Option<PathBuf>

Source file path of this layer if any.

data: DocumentMut

Configuration variables.

Implementations

impl ConfigLayer

pub fn empty(source: ConfigSource) -> Self

Creates new layer with empty data.

pub fn with_data(source: ConfigSource, data: DocumentMut) -> Self

Creates new layer with the configuration variables data.

pub fn parse(source: ConfigSource, text: &str) -> Result<Self, ConfigLoadError>

Parses TOML document text into new layer.

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

Loads TOML file from the specified path.

pub fn is_empty(&self) -> bool

Returns true if the table has no configuration variables.

pub fn look_up_table( &self, name: impl ToConfigNamePath, ) -> Result<Option<&ConfigTableLike<'_>>, &ConfigItem>

Looks up sub table by the name path. Returns Some(table) if a table was found at the path. Returns Err(item) if middle or leaf node wasn’t a table.

pub fn look_up_item( &self, name: impl ToConfigNamePath, ) -> Result<Option<&ConfigItem>, &ConfigItem>

Looks up item by the name path. Returns Some(item) if an item found at the path. Returns Err(item) if middle node wasn’t a table.

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

Sets new_value to the name path. Returns old value if any.

This function errors out if attempted to overwrite a non-table middle node or a leaf non-inline table. An inline table can be overwritten because it’s syntactically a value.

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

Deletes value specified by the name path. Returns old value if any.

Returns Ok(None) if middle node wasn’t a table or a value wasn’t found. Returns Err if attempted to delete a non-inline table. An inline table can be deleted because it’s syntactically a value.

pub fn ensure_table( &mut self, name: impl ToConfigNamePath, ) -> Result<&mut ConfigTableLike<'_>, ConfigUpdateError>

Inserts tables down to the name path. Returns mutable reference to the leaf table.

This function errors out if attempted to overwrite a non-table node. In file-system analogy, this is equivalent to std::fs::create_dir_all().

Trait Implementations

impl Clone for ConfigLayer

fn clone(&self) -> ConfigLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigLayer

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

Formats the value using the given formatter.