Struct shellfirm::Config

pub struct Config {
    pub latest_version: String,
    pub path: String,
    pub config_file_path: String,
    /* private fields */
}

describe configuration folder

Fields

latest_version: String

path: String

Configuration folder path.

config_file_path: String

config file.

Implementations

impl Config

pub fn load_config_from_file(&self) -> AnyResult<Context>

Convert user config yaml to struct.

Errors

Will return Err has an error when loading the config file

pub fn load_default_config(&self) -> AnyResult<Context>

Return default app config.

Errors

Will return Err could not parse default config to yaml file

pub fn update_config_version(&self, config: &Context) -> AnyResult<()>

update config file with the updated baseline checks.

Errors

Will return Err adding check group return an error

pub fn manage_config_file(&self) -> AnyResult<()>

Manage configuration folder & file.

• Create config folder if not exists.
• Create default config yaml file if not exists.

Errors

Will return Err file could not created or loaded

pub fn update_config_content(
    &self,
    remove_checks: bool,
    check_groups: &[String]
) -> AnyResult<()>

Update user settings files.

Arguments

• remove_checks - if true the given check_group parameter will remove from configuration / if false will add.
• check_groups - list of check groups to act.

Errors

Will return Err group didn’t added/removed

pub fn reset_config(&self, force_selection: Option<usize>) -> AnyResult<()>

Reset user configuration to the default app.

Errors

Will return Err create config folder return an error

pub fn update_challenge(&self, challenge: Challenge) -> AnyResult<()>

Update default user challenge.

Arguments

• challenge - new challenge to update

Errors

Will return Err error return on load/save config

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.