Struct spirit::cfg_loader::Builder

pub struct Builder { /* fields omitted */ }

A builder for the Loader.

See the module documentation for details about the use.

Implementations

impl Builder

pub fn new() -> Self

Creates a new config loader builder.

pub fn build<O: StructOpt>(self) -> (O, Loader)

Turns the builder into the Loader.

This parses the command line options ‒ the ones specified by the type parameter, enriched by options related to configuration (paths to config files and config overrides).

This returns the parsed options and the loader.

If the command line parsing fails, the application terminates (and prints relevant help).

pub fn build_no_opts(self) -> Loader

Turns this into the Loader, without command line parsing.

It is similar to build, but doesn't parse the command line, therefore only the config_default_paths are used to find the config files.

This is likely useful for tests.

pub fn build_explicit_opts<O, I>(self, args: I) -> Result<(O, Loader), AnyError> where
    O: StructOpt,
    I: IntoIterator,
    I::Item: Into<OsString> + Clone, 

Turns this into the Loader, and command line is parsed from the provided iterator.

Similar to the build, this returns the options and the loader. However, the options is loaded from the provided iterator and error is explicitly returned. This makes it better match for tests, but can be useful in other circumstances too.

Note that the 0th argument is considered to be the name of the application and is not parsed as an option.

Trait Implementations

impl ConfigBuilder for Builder

fn config_defaults<D: Into<String>>(self, config: D) -> Self

Specifies the default configuration.

fn config_default_paths<P, I>(self, paths: I) -> Self where
    I: IntoIterator<Item = P>,
    P: Into<PathBuf>, 

Sets the configuration paths in case the user doesn't provide any.

fn config_env<E: Into<String>>(self, env: E) -> Self

Enables loading configuration from environment variables.

fn config_filter<F: FnMut(&Path) -> bool + Send + 'static>(
    self,
    filter: F
) -> Self

Sets a configuration dir filter.

fn warn_on_unused(self, warn: bool) -> Self

Sets if warning should be produced for each unused configuration key.

fn config_defaults_typed<C: Serialize>(
    self,
    config: &C
) -> Result<Self, AnyError>

Specifies the default configuration as typed value.

fn config_ext<E: Into<OsString>>(self, ext: E) -> Self

Configures a config dir filter for a single extension.

fn config_exts<I, E>(self, exts: I) -> Self where
    I: IntoIterator<Item = E>,
    E: Into<OsString>, 

Configures a config dir filter for multiple extensions.

fn config_supported_exts(self) -> Self

Sets the config dir filter for all the supported extensions.

impl Default for Builder

fn default() -> Self

Returns the "default value" for a type.