Struct ConfigRuleSet 

pub struct ConfigRuleSet {
    pub main_files: Vec<ConfigFileRule>,
    pub fragments: Option<FragmentRule>,
}

Set of configuration file rules.

Defines all configuration files for an application, including main files, fragments, and legacy files.

Example

use cfgmatic_paths::{ConfigRuleSet, ConfigFileRule, FragmentRule};

let rules = ConfigRuleSet::builder()
    .main_file(ConfigFileRule::toml("config").required(true))
    .main_file(ConfigFileRule::extensions("config", &["yaml"]))
    .fragments(FragmentRule::new("conf.d", "*.conf"))
    .build();

Fields

main_files: Vec<ConfigFileRule>

Main configuration files.

fragments: Option<FragmentRule>

Fragment directory rule (optional).

Implementations

impl ConfigRuleSet

pub fn new() -> ConfigRuleSet

Create a new empty rule set.

pub fn builder() -> ConfigRuleSetBuilder

Create a new builder for rule sets.

pub fn add_main_file(&mut self, rule: ConfigFileRule)

Add a main file rule.

pub fn set_fragments(&mut self, fragments: FragmentRule)

Set the fragment rule.

pub fn main_files(&self) -> &[ConfigFileRule]

Get all main file rules.

pub const fn fragments(&self) -> Option<&FragmentRule>

Get the fragment rule if set.

Trait Implementations

impl Clone for ConfigRuleSet

fn clone(&self) -> ConfigRuleSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigRuleSet

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

Formats the value using the given formatter.

impl Default for ConfigRuleSet

fn default() -> ConfigRuleSet

Returns the “default value” for a type.