Struct XvcConfig

pub struct XvcConfig {
    pub current_dir: XvcConfigOption<AbsolutePath>,
    pub config_maps: Vec<XvcConfigMap>,
    pub the_config: HashMap<String, XvcConfigValue>,
    pub init_params: XvcConfigParams,
}

Keeps track of all Xvc configuration.

It’s created by [XvcRoot] using the options from [XvcConfigInitParams]. Keeps the current directory, that can also be set manually from the command line. It loads several config maps (one for each XvcConfigOptionSource) and cascadingly merges them to get an actual configuration.

Fields

current_dir: XvcConfigOption<AbsolutePath>

Current directory. It can be set with xvc -C option

config_maps: Vec<XvcConfigMap>

Configuration values for each level

the_config: HashMap<String, XvcConfigValue>

The current configuration map, updated cascadingly

init_params: XvcConfigParams

The init params used to create this config

Implementations

impl XvcConfig

pub fn get_str(&self, key: &str) -> Result<XvcConfigOption<String>, Error>

Returns string value for key.

The value is parsed from the corresponding TomlValue stored in [self.the_config].

pub fn get_bool(&self, key: &str) -> Result<XvcConfigOption<bool>, Error>

Returns bool value for key.

The value is parsed from the corresponding TomlValue stored in [self.the_config].

pub fn get_int(&self, key: &str) -> Result<XvcConfigOption<i64>, Error>

Returns int value for key.

The value is parsed from the corresponding TomlValue stored in [self.the_config].

pub fn get_float(&self, key: &str) -> Result<XvcConfigOption<f64>, Error>

Returns float value for key.

The value is parsed from the corresponding TomlValue stored in [self.the_config].

pub fn get_toml_value(&self, key: &str) -> Result<XvcConfigOption<Value>, Error>

Returns TOML value corresponding to key.

It’s returned without parsing from [self.the_config]

pub fn system_config_file() -> Result<PathBuf, Error>

Return the system configuration file path for Xvc

pub fn user_config_file() -> Result<PathBuf, Error>

Return the user configuration file path for Xvc

pub fn new(p: XvcConfigParams) -> Result<XvcConfig, Error>

Loads all config files Overrides all options with the given key=value style options in the command line

pub fn current_dir(&self) -> Result<&AbsolutePath, Error>

Where do we run the command?

This can be modified by options in the command line, so it’s not always equal to std::env::current_dir()

pub fn guid(&self) -> Option<String>

Globally Unique Identified for the Xvc Repository / Project

It’s stored in core.guid option. It’s created in [XvcRoot::init] and shouldn’t be tampered with. Storage commands use this to create different paths for different Xvc projects.

pub fn verbosity(&self) -> XvcVerbosity

The current verbosity level. Set with core.verbosity option.

pub fn get_val<T>(&self, key: &str) -> Result<T, Error>

where T: FromStr,

Returns a struct (T) value by using its FromStr implementation. It parses the string to get the value.

Trait Implementations

impl Clone for XvcConfig

fn clone(&self) -> XvcConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XvcConfig

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

Formats the value using the given formatter.

impl Display for XvcConfig

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

Formats the value using the given formatter.