Struct SearchDirectories

pub struct SearchDirectories<'a> { /* private fields */ }

A list of search directories that the config files will be searched under.

Implementations

impl<'a> SearchDirectories<'a>

pub const fn empty() -> Self

Start with an empty list of search directories.

pub fn classic_system() -> Self

Start with the default search directory roots for a system application on a classic Linux distribution.

The OS vendor ships configuration in /usr/lib, ephemeral configuration is defined in /var/run, and the sysadmin places overrides in /etc.

pub fn modern_system() -> Self

Start with the default search directory roots for a system application on a modern Linux distribution.

The OS vendor ships configuration in /usr/etc, ephemeral configuration is defined in /run, and the sysadmin places overrides in /etc.

pub fn with_user_directory(self) -> Self

Append the directory for local user config overrides, $XDG_CONFIG_HOME.

If the dirs crate feature is enabled, then dirs::config_dir() is used for the implementation of $XDG_CONFIG_HOME. else a custom implementation is used.

pub fn chroot(self, root: &Path) -> Result<Self, InvalidPathError>

Prepend the specified path to all search directories.

Errors

Returns Err(InvalidPathError) if root does not start with a Component::RootDir or if it contains Component::ParentDir.

pub fn push(&mut self, path: Cow<'a, Path>) -> Result<(), InvalidPathError>

Appends a search directory to the end of the list. Files found in this directory will override files found in earlier directories.

Errors

Returns Err(InvalidPathError) if path does not start with a Component::RootDir or if it contains Component::ParentDir.

pub fn with_project<TProject>( self, project: TProject, ) -> SearchDirectoriesForProject<'a, TProject>

Search for configuration files for the given project name.

The project name is usually the name of your application.

pub fn with_file_name<TFileName>( self, file_name: TFileName, ) -> SearchDirectoriesForFileName<'a, TFileName>

Search for configuration files with the given config file name.

Trait Implementations

impl<'a> Clone for SearchDirectories<'a>

fn clone(&self) -> SearchDirectories<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SearchDirectories<'a>

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

Formats the value using the given formatter.

impl Default for SearchDirectories<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> FromIterator<Cow<'a, Path>> for SearchDirectories<'a>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Cow<'a, Path>>,

Creates a value from an iterator.