Enum ConfigFile 

pub enum ConfigFile {
    GenericToml(PathBuf),
    GenericYaml(PathBuf),
    SpecificToml {
        path: PathBuf,
        profile: String,
    },
    SpecificYaml {
        path: PathBuf,
        profile: String,
    },
}

Represents a single config file.

Variants

GenericToml(PathBuf)

A file like app.toml.

GenericYaml(PathBuf)

A file like app.yaml / app.yml.

SpecificToml

A file like app.prod.toml.

Fields

path: PathBuf

The path to the file.

profile: String

The associated profile name.

SpecificYaml

A file like app.prod.yaml / app.prod.yml.

Fields

path: PathBuf

The path to the file.

profile: String

The associated profile name.

Implementations

impl ConfigFile

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

Creates a ConfigFile from the given PathBuf, if the path points to a workable config file.

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

Creates a ConfigFile from the given PathBuf, if the path points to a workable config file, optionally applying the given known profile name.

impl ConfigFile

pub fn is_generic(&self) -> bool

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

pub fn is_specific(&self) -> bool

Reports whether this ConfigFile 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 ConfigFile applies to the active AppProfile.

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

Reports whether this ConfigFile 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.

Trait Implementations

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl From<ConfigFile> for File<FileSourceFile, FileFormat>

fn from(file: ConfigFile) -> Self

Converts to this type from the input type.

impl From<ConfigFile> for PathBuf

fn from(file: ConfigFile) -> Self

Converts to this type from the input type.

impl Ord for ConfigFile

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

Implements the custom ordering rules for ConfigFile.

First rule is that generics always come before specifics (so that specifics would override generics). After that, both subgroups are ordered by their file path. For specific files, we order by the profile name before we order by the path.

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 ConfigFile

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

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

Delegates to the Ord implementation.

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 ConfigFile

impl StructuralPartialEq for ConfigFile