Enum ConfigEntry 

pub enum ConfigEntry {
    Directory(ConfigDir),
    File(ConfigFile),
}

Represents a filesystem entry that is relevant for config files.

Variants

Directory(ConfigDir)

A directory.

File(ConfigFile)

A config file.

Implementations

impl ConfigEntry

pub fn dir(path: PathBuf) -> Self

Creates a directory-type ConfigEntry from the given path with no questions asked (no validation on the path).

This is intended for creating root entries.

pub fn try_from(path: PathBuf) -> Option<Self>

Creates a ConfigEntry from the given PathBuf, if the path points to a workable config-related filesystem entry.

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

Creates a ConfigEntry from the given PathBuf, if the path points to a workable config-related filesystem entry, optionally applying the given known profile name to the config files.

impl ConfigEntry

pub fn is_directory(&self) -> bool

Reports whether this ConfigEntry is a directory.

pub fn is_file(&self) -> bool

Reports whether this ConfigEntry is a config file.

pub fn path(&self) -> &PathBuf

Returns a reference to the internally held PathBuf.

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

Returns a reference to the internally held file/directory name.

pub fn applies_to_active_profile(&self) -> bool

Reports whether this ConfigEntry applies to the active AppProfile.

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

Reports whether this ConfigEntry applies to the given AppProfile.

Delegates to the underlying logic for both the directory and the file variants.

pub fn to_config_file(self) -> Option<ConfigFile>

Consumes this ConfigEntry and yields only ConfigFiles.

impl ConfigEntry

pub fn cd(self) -> ConfigEntryIter

Iterates over ConfigEntrys that are the immediate children of this ConfigEntry, if this entry is a directory. If this entry is a file, yields a Once iterator over that file.

If this entry is a directory that is associated with a profile — the profile is carried over into all nested entries.

All failure conditions (e.g., non-existing paths, un-readable files) are silently ignored.

This is intended for convenient flat-mapping to move deeper into nested directories, if any.

pub fn cd_capturing_profile(self) -> ConfigEntryIter

Same as cd, but if this entry is a directory, then instead of carrying over the profile that this directory may be associated with, captures the profile from this directory’s name.

pub fn cd_forgetting_profile(self) -> ConfigEntryIter

Same as cd, but if this entry is a directory, then instead of carrying over the profile that this directory may be associated with, explicitly “forgets” any associated profile: the children entries will not be associated with any profile.

Trait Implementations

impl Debug for ConfigEntry

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

Formats the value using the given formatter.

impl From<ConfigEntry> for PathBuf

fn from(file: ConfigEntry) -> Self

Converts to this type from the input type.

impl Ord for ConfigEntry

fn cmp(&self, other: &ConfigEntry) -> 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 ConfigEntry

fn eq(&self, other: &ConfigEntry) -> 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 ConfigEntry

fn partial_cmp(&self, other: &ConfigEntry) -> 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 ConfigEntry

impl StructuralPartialEq for ConfigEntry