Struct StackedConfig

pub struct StackedConfig { /* private fields */ }

Stack of configuration layers which can be merged as needed.

A StackedConfig is something like a read-only overlayfs. Tables and values are directories and files respectively, and tables are merged across layers. Tables and values can be addressed by dotted name paths.

There’s no tombstone notation to remove items from the lower layers.

Beware that arrays of tables are no different than inline arrays. They are values, so are never merged. This might be confusing because they would be merged if two TOML documents are concatenated literally. Avoid using array of tables syntax.

Implementations

impl StackedConfig

pub fn empty() -> Self

Creates an empty stack of configuration layers.

pub fn with_defaults() -> Self

Creates a stack of configuration layers containing the default variables referred to by jj-lib.

pub fn load_file( &mut self, source: ConfigSource, path: impl Into<PathBuf>, ) -> Result<(), ConfigLoadError>

Loads config file from the specified path, inserts it at the position specified by source. The file should exist.

pub fn load_dir( &mut self, source: ConfigSource, path: impl AsRef<Path>, ) -> Result<(), ConfigLoadError>

Loads config files from the specified directory path, inserts them at the position specified by source. The directory should exist.

pub fn add_layer(&mut self, layer: impl Into<Arc<ConfigLayer>>)

Inserts new layer at the position specified by layer.source.

pub fn extend_layers<I>(&mut self, layers: I)

where I: IntoIterator, I::Item: Into<Arc<ConfigLayer>>,

Inserts multiple layers at the positions specified by layer.source.

pub fn remove_layers(&mut self, source: ConfigSource)

Removes layers of the specified source.

pub fn layers(&self) -> &[Arc<ConfigLayer>]

Layers sorted by precedence.

pub fn layers_mut(&mut self) -> &mut [Arc<ConfigLayer>]

Mutable references to layers sorted by precedence.

pub fn layers_for(&self, source: ConfigSource) -> &[Arc<ConfigLayer>]

Layers of the specified source.

pub fn get<'de, T: Deserialize<'de>>( &self, name: impl ToConfigNamePath, ) -> Result<T, ConfigGetError>

Looks up value of the specified type T from all layers, merges sub fields as needed.

pub fn get_value( &self, name: impl ToConfigNamePath, ) -> Result<ConfigValue, ConfigGetError>

Looks up value from all layers, merges sub fields as needed.

pub fn get_value_with<T, E: Into<Box<dyn Error + Send + Sync>>>( &self, name: impl ToConfigNamePath, convert: impl FnOnce(ConfigValue) -> Result<T, E>, ) -> Result<T, ConfigGetError>

Looks up value from all layers, merges sub fields as needed, then converts the value by using the given function.

pub fn get_table( &self, name: impl ToConfigNamePath, ) -> Result<ConfigTable, ConfigGetError>

Looks up sub table from all layers, merges fields as needed.

Use table_keys(prefix) and get([prefix, key]) instead if table values have to be converted to non-generic value type.

pub fn table_keys( &self, name: impl ToConfigNamePath, ) -> impl Iterator<Item = &str>

Returns iterator over sub table keys in order of layer precedence. Duplicated keys are omitted.

Trait Implementations

impl Clone for StackedConfig

fn clone(&self) -> StackedConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StackedConfig

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

Formats the value using the given formatter.