Struct XvcConfigParams

pub struct XvcConfigParams {
    pub default_configuration: String,
    pub current_dir: AbsolutePath,
    pub include_system_config: bool,
    pub include_user_config: bool,
    pub project_config_path: Option<AbsolutePath>,
    pub local_config_path: Option<AbsolutePath>,
    pub include_environment_config: bool,
    pub command_line_config: Option<Vec<String>>,
}

How should we initialize the configuration?

It’s possible to ignore certain sources by supplying None to their values here.

Fields

default_configuration: String

The default configuration for the project. It should contain all default values as a TOML document. Xvc produces this in [xvc_core::default_configuration].

current_dir: AbsolutePath

The directory where the application runs. This can be set by various Options. It affects how paths are handled in general.

include_system_config: bool

Should we include system configuration? If true, it’s read from [SYSTEM_CONFIG_DIRS].

include_user_config: bool

Should the user’s (home) config be included. If true, it’s read from [USER_CONFIG_DIRS].

project_config_path: Option<AbsolutePath>

Where should we load the project’s (public) configuration? It’s loaded in [XvcRootInner::new] TODO: Add a option to ignore this

local_config_path: Option<AbsolutePath>

Where should we load the project’s (private) configuration? It’s loaded in [XvcRootInner::new] TODO: Add a option to ignore this

include_environment_config: bool

Should we include configuration from the environment. If true, look for all variables in the form

XVC_group.key=value

from the environment and put them into the configuration.

command_line_config: Option<Vec<String>>

Command line configuration

Implementations

impl XvcConfigParams

pub fn new( default_configuration: String, current_dir: AbsolutePath, ) -> XvcConfigParams

Create a new blank config params

pub fn include_system_config( self, include_system_config: bool, ) -> XvcConfigParams

Update include_system_config value

pub fn include_user_config(self, include_user_config: bool) -> XvcConfigParams

Update include_user_config value

pub fn project_config_path( self, project_config_path: Option<AbsolutePath>, ) -> XvcConfigParams

Update project config path

pub fn local_config_path( self, local_config_path: Option<AbsolutePath>, ) -> XvcConfigParams

Update local config path

pub fn include_environment_config( self, include_environment_config: bool, ) -> XvcConfigParams

Whether to include enviroment variables in the configuration

pub fn command_line_config( self, command_line_config: Option<Vec<String>>, ) -> XvcConfigParams

Command line config from key=value definitions

Trait Implementations

impl Clone for XvcConfigParams

fn clone(&self) -> XvcConfigParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XvcConfigParams

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

Formats the value using the given formatter.