Struct confique::Builder

pub struct Builder<C: Config> { /* private fields */ }

Convenience builder to configure, load and merge multiple configuration sources.

Sources specified earlier have a higher priority. Obtained via Config::builder.

Implementations

impl<C: Config> Builder<C>

pub fn file(self, path: impl Into<PathBuf>) -> Self

Adds a configuration file as source. Infers the format from the file extension. If the path has no file extension or the extension is unknown, Builder::load will return an error.

The file is not considered required: if the file does not exist, an empty configuration (C::Partial::empty()) is used for this layer.

pub fn env(self) -> Self

Adds the environment variables as a source.

pub fn preloaded(self, partial: C::Partial) -> Self

Adds an already loaded partial configuration as source.

pub fn load(self) -> Result<C, Error>

Loads all configured sources in order. Earlier sources have a higher priority, later sources only fill potential gaps.

Will return an error if loading the sources fails or if the merged configuration does not specify all required values.