Struct tor_config::sources::ConfigurationSources

pub struct ConfigurationSources { /* private fields */ }

A description of where to find our configuration options.

Implementations

impl ConfigurationSources

pub fn new_empty() -> Self

Create a new empty ConfigurationSources.

pub fn from_cmdline<F, O>(
    default_config_file: impl Into<PathBuf>,
    config_files_options: impl IntoIterator<Item = F>,
    cmdline_toml_override_options: impl IntoIterator<Item = O>
) -> Self where
    F: Into<PathBuf>,
    O: Into<String>, 

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)
• cmdline_toml_override_options: Overrides (“key=value”)

The caller should also provide default_config_file, the default location of the configuration file. This is used if no file(s) are specified on the command line.

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

pub fn push_file(&mut self, p: impl Into<PathBuf>)

Add p to the list of files 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_optional_file(&mut self, p: impl Into<PathBuf>)

As push_file, but if the listed file can’t be loaded, loading the configuration can still 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

pub fn mistrust(&self) -> &Mistrust

Reads the filesystem permission mistrust

pub fn files(&self) -> impl Iterator<Item = &Path>

Return an iterator over the files that we care about.

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

Load the configuration into a new config::Config.

Trait Implementations

impl Clone for ConfigurationSources

fn clone(&self) -> ConfigurationSources

Returns a copy 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

Formats the value using the given formatter.

impl Default for ConfigurationSources

fn default() -> ConfigurationSources

Returns the “default value” for a type.