Struct mz::config_file::ConfigFile

pub struct ConfigFile {
    path: PathBuf,
    parsed: TomlConfigFile,
    editable: Document,
}

Represents an on-disk configuration file for mz.

Fields

path: PathBuf

parsed: TomlConfigFile

editable: Document

Implementations

impl ConfigFile

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

Computes the default path for the configuration file.

pub async fn load(path: PathBuf) -> Result<ConfigFile, Error>

Loads a configuration file from the specified path.

pub fn load_profile<'a>(&'a self, name: &'a str) -> Result<Profile<'_>, Error>

Loads a profile from the configuration file. Panics if the profile is not found.

pub async fn add_profile( &self, name: String, profile: TomlProfile, ) -> Result<(), Error>

Adds a new profile to the config file.

pub fn add_app_password( &self, new_profile: &mut Table, _name: &str, profile: TomlProfile, ) -> Result<(), Error>

Adds an app-password to the configuration file.

pub async fn remove_profile<'a>(&self, name: &str) -> Result<(), Error>

Removes a profile from the configuration file.

pub fn profile(&self) -> &str

Retrieves the default profile

pub fn vault(&self) -> &str

Retrieves the default vault value

pub fn profiles(&self) -> Option<BTreeMap<String, TomlProfile>>

Retrieves all the available profiles

pub fn list_profile_params( &self, profile_name: &str, ) -> Result<Vec<(&str, Option<String>)>, Error>

Returns a list of all the possible profile configuration values

pub fn get_profile_param<'a>( &'a self, name: &str, profile: &'a str, ) -> Result<Option<&str>, Error>

Gets the value of a profile’s configuration parameter.

pub async fn set_profile_param( &self, profile_name: &str, name: &str, value: Option<&str>, ) -> Result<(), Error>

Sets the value of a profile’s configuration parameter.

pub fn get_param(&self, name: &str) -> Result<Option<&str>, Error>

Gets the value of a configuration parameter.

pub fn list_params(&self) -> Vec<(&str, Option<&str>)>

Lists the all configuration parameters.

pub async fn set_param( &self, name: &str, value: Option<&str>, ) -> Result<(), Error>

Sets the value of a configuration parameter.

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a copy of the value.

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

Performs copy-assignment from source.