Struct ConfigLoader 

pub struct ConfigLoader<T: Config> { /* private fields */ }

A system for loading configuration from multiple sources in multiple formats, and generating a final result after merging and validating layers.

Implementations

impl<T: Config> ConfigLoader<T>

pub fn new() -> Self

Create a new config loader and auto-register formats based on enables features.

pub fn add_format( &mut self, format: impl SourceFormat<T::Partial> + 'static, ) -> &mut Self

Add a format to parse sources based on file name/extension detection.

pub fn code<S: TryInto<String>, P: TryInto<PathBuf>>( &mut self, code: S, path: P, ) -> Result<&mut Self, ConfigError>

Add a code snippet source to load, with a required file name.

pub fn file<P: TryInto<PathBuf>>( &mut self, path: P, ) -> Result<&mut Self, ConfigError>

Add a file source to load.

pub fn file_optional<S: TryInto<PathBuf>>( &mut self, path: S, ) -> Result<&mut Self, ConfigError>

Add a file source to load but don’t error if the file doesn’t exist.

pub fn source(&mut self, source: Source) -> Result<&mut Self, ConfigError>

Add a custom source.

pub fn url<S: TryInto<String>>( &mut self, url: S, ) -> Result<&mut Self, ConfigError>

Add a URL source to load.

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

Load, parse, merge, and validate all sources into a final configuration.

pub fn load_with_context( &self, context: &<T::Partial as PartialConfig>::Context, ) -> Result<ConfigLoadResult<T>, ConfigError>

Load, parse, merge, and validate all sources into a final configuration with the provided context. Context will be passed to all applicable default, merge, and validate functions defined with #[setting].

pub fn load_partial( &self, context: &<T::Partial as PartialConfig>::Context, ) -> Result<T::Partial, ConfigError>

Load, parse, and merge all sources into a partial configuration with the provided context. This does not inherit default values, environment variables, or run a final validation.

Partials can be converted to full with Config::from_partial.

pub fn set_cacher(&mut self, cacher: impl Cacher + 'static) -> &mut Self

Set a cacher instance that’ll read and write the cache for URL requests.

pub fn set_help<H: AsRef<str>>(&mut self, help: H) -> &mut Self

Set a string of help text to include in validation errors.

pub fn set_root<P: AsRef<Path>>(&mut self, root: P) -> &mut Self

Set the project root directory, for use within error messages.

Trait Implementations

impl<T: Config> Default for ConfigLoader<T>

fn default() -> Self

Returns the “default value” for a type.