Struct FoundConfigFiles

pub struct FoundConfigFiles<'srcs> {
    files: Vec<FoundConfigFile>,
    sources: &'srcs ConfigurationSources,
}

Configuration files and directories we found in the filesystem

Result of ConfigurationSources::scan.

When loading configuration files and also watching for filesystem updates, this type encapsulates all the actual filesystem objects that need watching.

Fields

files: Vec<FoundConfigFile>

The things we found

This includes both:

• Files which ought to be read
• Directories, which may or may not contain any currently-relevant files

The directories are retained for the purpose of watching for config changes: we will want to detect files being created within them, so our caller needs to discover them (via FoundConfigFiles::iter()).

sources: &'srcs ConfigurationSources

Our parent, which contains details we need for load

Implementations

impl FoundConfigFiles<'_>

pub fn iter(&self) -> impl Iterator<Item = &ConfigurationSource>

Iterate over the filesystem objects that the scan found

fn add_sources(self, builder: Figment) -> Result<Figment, ConfigError>

Add every file and commandline source to builder, returning a new builder.

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

Load the configuration into a new ConfigurationTree.

Trait Implementations

impl<'srcs> Debug for FoundConfigFiles<'srcs>

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

Formats the value using the given formatter.