Enum ConfigDir 

pub enum ConfigDir {
    Generic(PathBuf),
    Specific {
        path: PathBuf,
        profile: String,
    },
}

Represents a single config-related directory.

Unlike with [ConfigFile]s, the path validity is not checked on instantiation. But given that the filesystem is completely external to the application, the existence or validity of any given path cannot be assumed anyway.

Variants

Generic(PathBuf)

A directory that is not associated with an AppProfile.

Specific

A directory that is associated with an AppProfile of the given name.

Fields

path: PathBuf

The path to the directory.

profile: String

The associated profile name.

Implementations

impl ConfigDir

pub fn at(path: PathBuf) -> Self

Creates a ConfigDir from the given PathBuf, if the path points to a workable directory.

pub fn make_with_profile(path: PathBuf, known_profile: Option<&str>) -> Self

Creates a ConfigDir from the given PathBuf, if the path points to a workable directory, optionally applying the given known profile name.

pub fn make_capturing_profile(path: PathBuf) -> Self

Creates a ConfigDir from the given PathBuf, attempting to capture its name as a profile name. If the name cannot be captured (e.g., if the path doesn’t exist), the generic variant is returned.

impl ConfigDir

pub fn name(&self) -> Option<&str>

Reports the name of this directory, if it is readable.

pub fn is_generic(&self) -> bool

Reports whether this ConfigDir is applicable regardless of the active AppProfile.

pub fn is_specific(&self) -> bool

Reports whether this ConfigDir is applicable only to a particular AppProfile.

pub fn path(&self) -> &PathBuf

Returns a reference to the internally held PathBuf.

pub fn profile(&self) -> Option<&str>

Returns a reference to the internally held profile name (if this variant is specific).

pub fn applies_to_active_profile(&self) -> bool

Reports whether this ConfigDir applies to the active AppProfile.

pub fn applies_to(&self, profile: impl AsRef<AppProfile>) -> bool

Reports whether this ConfigDir applies to the given AppProfile.

A generic config file (without a profile name in its file name) applies to any profile by default. A specific config file (with a profile name in its file name) applies to the given profile if the profile name matches.

pub fn expand(&self, profile: Option<&str>) -> Vec<ConfigEntry>

Expands this directory into a vector of nested ConfigEntrys.

Trait Implementations

impl Debug for ConfigDir

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

Formats the value using the given formatter.

impl From<ConfigDir> for PathBuf

fn from(file: ConfigDir) -> Self

Converts to this type from the input type.

impl Ord for ConfigDir

fn cmp(&self, other: &ConfigDir) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ConfigDir

fn eq(&self, other: &ConfigDir) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ConfigDir

fn partial_cmp(&self, other: &ConfigDir) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ConfigDir

impl StructuralPartialEq for ConfigDir