Struct ConfigFileRule 

pub struct ConfigFileRule {
    pub pattern: FilePattern,
    pub tiers: TierSearchMode,
    pub required: bool,
}

Rule for finding a single configuration file.

Defines how to search for a specific configuration file across different tiers (User, Local, System) and what to do when multiple instances are found.

Example

use cfgmatic_paths::{ConfigFileRule, TierSearchMode};

let rule = ConfigFileRule::extensions("config", &["toml", "yaml"])
    .tiers(TierSearchMode::All)
    .required(true);

Fields

pattern: FilePattern

File pattern to match.

tiers: TierSearchMode

Which tiers to search for this file.

required: bool

Whether the file is required (error if not found).

Implementations

impl ConfigFileRule

pub fn toml(base: impl Into<String>) -> ConfigFileRule

Create a new rule for a file with a single extension.

Example

use cfgmatic_paths::ConfigFileRule;

let rule = ConfigFileRule::toml("config");

pub fn extensions( base: impl Into<String>, extensions: &[&str], ) -> ConfigFileRule

Create a new rule for a file with multiple extensions.

Example

use cfgmatic_paths::ConfigFileRule;

let rule = ConfigFileRule::extensions("config", &["toml", "yaml", "json"]);

pub fn exact(name: impl Into<String>) -> ConfigFileRule

Create a new rule for an exact filename match.

Example

use cfgmatic_paths::ConfigFileRule;

let rule = ConfigFileRule::exact("main.conf");

pub fn glob(pattern: impl Into<String>) -> ConfigFileRule

Create a new rule for glob pattern matching.

Example

use cfgmatic_paths::ConfigFileRule;

let rule = ConfigFileRule::glob("*.conf");

pub const fn tiers(self, tiers: TierSearchMode) -> ConfigFileRule

Set which tiers to search.

Example

use cfgmatic_paths::{ConfigFileRule, TierSearchMode, ConfigTier};

let rule = ConfigFileRule::toml("config")
    .tiers(TierSearchMode::FromTier(ConfigTier::System));

pub const fn required(self, required: bool) -> ConfigFileRule

Mark the file as required.

Example

use cfgmatic_paths::ConfigFileRule;

let rule = ConfigFileRule::toml("config")
    .required(true);

Trait Implementations

impl Clone for ConfigFileRule

fn clone(&self) -> ConfigFileRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFileRule

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

Formats the value using the given formatter.

impl PartialEq for ConfigFileRule

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

impl StructuralPartialEq for ConfigFileRule