Struct SearchDirectoriesForProjectAndFileName

pub struct SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName> { /* private fields */ }

A list of search directories that the config files will be searched under, scoped to a particular project and config file name.

Implementations

impl<'a, TProject, TFileName> SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName>

pub fn find_files<TDropinSuffix>( self, dropin_suffix: Option<TDropinSuffix>, ) -> Result<Files>

where TProject: AsRef<OsStr>, TFileName: AsRef<OsStr>, TDropinSuffix: AsRef<OsStr>,

Returns an Iterator of (PathBuf, File)s for all the files found in the specified search directories. The project name is appended to each search directory, then those directories are searched for files named file_name.

If dropin_suffix is provided, then directories named format!("{file_name}.d") under the search directories are treated as dropin directories. Only dropin files whose name ends with dropin_suffix will be considered. Note that if you intend to use a file extension as a suffix, then dropin_suffix must include the ., such as ".conf".

You will likely want to parse each file returned by this function according to whatever format they’re supposed to contain and merge them into a unified config object, with settings from later files overriding settings from earlier files. This function does not guarantee that the files are well-formed, only that they exist and could be opened for reading.

Errors

Any errors from reading non-existing directories and non-existing files are ignored. Apart from that, any I/O errors from walking the directories and from opening the files found within are propagated.

Trait Implementations

impl<'a, TProject: Clone, TFileName: Clone> Clone for SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName>

fn clone( &self, ) -> SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, TProject: Debug, TFileName: Debug> Debug for SearchDirectoriesForProjectAndFileName<'a, TProject, TFileName>

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

Formats the value using the given formatter.