Struct ConfigFile 

pub struct ConfigFile {
    pub cache: Option<CacheConfig>,
    pub clouds: Option<HashMap<String, CloudConfig>>,
    pub public_clouds: Option<HashMap<String, CloudConfig>>,
}

ConfigFile structure.

Fields

cache: Option<CacheConfig>

Cache configuration.

clouds: Option<HashMap<String, CloudConfig>>

clouds configuration.

public_clouds: Option<HashMap<String, CloudConfig>>

vendor clouds information (profiles).

Implementations

impl ConfigFile

pub fn builder() -> ConfigFileBuilder

A builder to create a ConfigFile by specifying which files to load.

pub fn new_with_user_specified_configs( clouds: Option<impl AsRef<Path>>, secure: Option<impl AsRef<Path>>, ) -> Result<Self, ConfigError>

Create a ConfigFile which also loads the default sources in the following order:

• clouds-public.{yaml,yml,json} (see find_vendor_file for search paths)
• clouds.{yaml,yml,json} (see find_clouds_file for search paths)
• the provided clouds file
• secure.{yaml,yml,json} (see find_secure_file for search paths)
• the provided secure file

If a source is not a valid config it will be ignored, but if one of the sources has syntax errors (YAML/JSON) or one of the user specified configs does not exist, a ConfigError will be returned.

pub fn new() -> Result<Self, ConfigError>

A convenience function which calls new_with_user_specified_configs without an additional clouds or secret file.

pub fn get_cloud_config<S: AsRef<str>>( &self, cloud_name: S, ) -> Result<Option<CloudConfig>, ConfigError>

Get cloud connection configuration by name.

This method does not raise exception when the cloud is not found.

pub fn is_auth_cache_enabled(&self) -> bool

Return true if auth caching is enabled.

pub fn get_available_clouds(&self) -> Vec<String>

Return list of available cloud connections.

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.