Struct ConfigurationSources

pub struct ConfigurationSources {
    files: Vec<(ConfigurationSource, MustRead)>,
    options: Vec<String>,
    mistrust: Mistrust,
}

A description of where to find our configuration options.

Fields

files: Vec<(ConfigurationSource, MustRead)>

options: Vec<String>

mistrust: Mistrust

Implementations

impl ConfigurationSources

pub fn new_empty() -> ConfigurationSources

Create a new empty ConfigurationSources.

pub fn from_cmdline<F, O>( default_config_files: impl IntoIterator<Item = ConfigurationSource>, config_files_options: impl IntoIterator<Item = F>, cmdline_toml_override_options: impl IntoIterator<Item = O>, ) -> ConfigurationSources

where F: Into<PathBuf>, O: Into<String>,

Establish a ConfigurationSources the from an infallible command line and defaults

Convenience method for if the default config file location(s) can be infallibly computed.

pub fn try_from_cmdline<F, O, DEF, E>( default_config_files: impl FnOnce() -> Result<DEF, E>, config_files_options: impl IntoIterator<Item = F>, cmdline_toml_override_options: impl IntoIterator<Item = O>, ) -> Result<ConfigurationSources, E>

where F: Into<PathBuf>, O: Into<String>, DEF: IntoIterator<Item = ConfigurationSource>,

Establish a ConfigurationSources the usual way from a command line and defaults

The caller should have parsed the program’s command line, and extracted (inter alia)

• config_files_options: Paths of config file(s) (or directories of .toml files)
• cmdline_toml_override_options: Overrides (“key=value”)

The caller should also provide default_config_files, which returns the default locations of the configuration files. This used if no file(s) are specified on the command line.

mistrust is used to check whether the configuration files have appropriate permissions.

ConfigurationSource::Dirs will be scanned for files whose name ends in .toml. All those files (if any) will be read (in lexical order by filename).

pub fn push_source(&mut self, src: ConfigurationSource, must_read: MustRead)

Add src to the list of files or directories that we want to read configuration from.

Configuration files are loaded and applied in the order that they are added to this object.

If the listed file is absent, loading the configuration won’t succeed.

pub fn push_option(&mut self, option: impl Into<String>)

Add s to the list of overridden options to apply to our configuration.

Options are applied after all configuration files are loaded, in the order that they are added to this object.

The format for s is as in [CmdLine].

pub fn set_mistrust(&mut self, mistrust: Mistrust)

Sets the filesystem permission mistrust

This value only indicates whether and how to check permissions on the configuration file itself. It does not specify whether and how to check permissions of the paths provided within. This is defined by the storage.permissions.dangerously_trust_everyone flag.

pub fn mistrust(&self) -> &Mistrust

Reads the filesystem permission mistrust

This value only indicates whether and how to check permissions on the configuration file itself. It does not specify whether and how to check permissions of the paths provided within. This is defined by the storage.permissions.dangerously_trust_everyone flag.

pub fn load(&self) -> Result<ConfigurationTree, ConfigError>

Scan for files and load the configuration into a new [ConfigurationTree].

This is a convenience method for scan() followed by files.load.

pub fn scan(&self) -> Result<FoundConfigFiles<'_>, ConfigError>

Scan for configuration source files (including scanning any directories)

Trait Implementations

impl Clone for ConfigurationSources

fn clone(&self) -> ConfigurationSources

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationSources

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

Formats the value using the given formatter.

impl Default for ConfigurationSources

fn default() -> ConfigurationSources

Returns the “default value” for a type.