Struct ConfigLayer 

pub struct ConfigLayer { /* private fields */ }

Ordered collection of config entries from one source layer.

Implementations

impl ConfigLayer

pub fn entries(&self) -> &[LayerEntry]

Returns the entries in insertion order.

pub fn extend_from_layer(&mut self, other: &ConfigLayer)

Appends every entry from another layer in insertion order.

Later entries from other win over earlier entries in this layer when the resolver evaluates duplicate keys from the same source layer.

Examples

use osp_cli::config::ConfigLayer;

let mut base = ConfigLayer::default();
base.set("theme.name", "dracula");

let mut site = ConfigLayer::default();
site.set("extensions.site.enabled", true);
site.set("theme.name", "nord");

base.extend_from_layer(&site);

assert_eq!(base.entries().len(), 3);
assert_eq!(base.entries()[2].key, "theme.name");
assert_eq!(base.entries()[2].value.to_string(), "nord");

pub fn set<K, V>(&mut self, key: K, value: V)

where K: Into<String>, V: Into<ConfigValue>,

Inserts a global entry.

Examples

use osp_cli::config::{ConfigLayer, Scope};

let mut layer = ConfigLayer::default();
layer.set("theme.name", "dracula");

let entry = &layer.entries()[0];
assert_eq!(entry.key, "theme.name");
assert_eq!(entry.scope, Scope::global());

pub fn set_for_profile<K, V>(&mut self, profile: &str, key: K, value: V)

where K: Into<String>, V: Into<ConfigValue>,

Inserts an entry scoped to a profile.

pub fn set_for_terminal<K, V>(&mut self, terminal: &str, key: K, value: V)

where K: Into<String>, V: Into<ConfigValue>,

Inserts an entry scoped to a terminal.

pub fn set_for_profile_terminal<K, V>( &mut self, profile: &str, terminal: &str, key: K, value: V, )

where K: Into<String>, V: Into<ConfigValue>,

Inserts an entry scoped to both profile and terminal.

pub fn insert<K, V>(&mut self, key: K, value: V, scope: Scope)

where K: Into<String>, V: Into<ConfigValue>,

Inserts an entry with an explicit scope.

pub fn insert_with_origin<K, V, O>( &mut self, key: K, value: V, scope: Scope, origin: Option<O>, )

where K: Into<String>, V: Into<ConfigValue>, O: Into<String>,

Inserts an entry and records its external origin.

pub fn mark_all_secret(&mut self)

Marks every entry in the layer as secret.

pub fn remove_scoped(&mut self, key: &str, scope: &Scope) -> Option<ConfigValue>

Removes the last matching entry for a key and scope.

Examples

use osp_cli::config::{ConfigLayer, ConfigValue, Scope};

let mut layer = ConfigLayer::default();
layer.set("theme.name", "catppuccin");
layer.set("theme.name", "dracula");

let removed = layer.remove_scoped("theme.name", &Scope::global());
assert_eq!(removed, Some(ConfigValue::String("dracula".to_string())));

pub fn from_toml_str(raw: &str) -> Result<Self, ConfigError>

Parses a config layer from the project’s TOML layout.

Examples

use osp_cli::config::ConfigLayer;

let layer = ConfigLayer::from_toml_str(r#"
[default]
theme.name = "dracula"

[profile.tsd]
ui.format = "json"
"#).unwrap();

assert_eq!(layer.entries().len(), 2);

pub fn from_env_iter<I, K, V>(vars: I) -> Result<Self, ConfigError>

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: AsRef<str>,

Builds a config layer from OSP__... environment variables.

Trait Implementations

impl Clone for ConfigLayer

fn clone(&self) -> ConfigLayer

Returns a duplicate 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.

impl Default for ConfigLayer

fn default() -> ConfigLayer

Returns the “default value” for a type.