Enum ConfigScope 

pub enum ConfigScope {
    Preferences,
    UserGlobal,
    ProjectLocal,
    LocalData,
    PersistentData,
    Runtime,
}

Configuration scope representing different layers of configuration sources.

The scope system allows applications to organize configuration across multiple layers with clear precedence: defaults → user prefs → global config → project config → local data → persistent data → runtime overrides.

Scopes

• Preferences: User application preferences (via BaseDirs::preference_dir())
• UserGlobal: User configuration applying across all projects (via ProjectDirs::config_dir())
• ProjectLocal: Project-specific configuration (current directory)
• LocalData: Machine-local data not synced across machines (via BaseDirs::data_local_dir())
• PersistentData: Cross-machine persistent application state (via BaseDirs::data_dir())
• Runtime: Dynamic configuration from environment variables and CLI (not file-based)

Precedence Order

When using MultiScopeConfig, scopes are typically loaded in this order:

1. Preferences
2. UserGlobal
3. ProjectLocal
4. LocalData
5. PersistentData
6. Runtime (env vars + CLI, handled separately)

Later scopes override earlier ones during configuration merging.

Example

use settings_loader::ConfigScope;

let scopes = vec![
    ConfigScope::Preferences,
    ConfigScope::UserGlobal,
    ConfigScope::ProjectLocal,
];

// Use in collections
let mut scope_map = std::collections::HashMap::new();
scope_map.insert(ConfigScope::Preferences, "user prefs");

Variants

Preferences

User application preferences

Platform-specific locations:

• Linux: ~/.config/APP_NAME (or XDG_CONFIG_HOME/APP_NAME)
• macOS: ~/Library/Preferences/APP_NAME
• Windows: %APPDATA%/APP_NAME

UserGlobal

User configuration applying across all projects

Platform-specific locations:

• Linux: ~/.config/APP_NAME (or XDG_CONFIG_HOME/APP_NAME)
• macOS: ~/Library/Application Support/ORG_NAME.APP_NAME
• Windows: %APPDATA%/ORG_NAME/APP_NAME

ProjectLocal

Project-specific configuration in current directory

Location: ./settings.{ext} (any supported format) Searchable with find_config_in().

LocalData

Machine-local data not synced across machines

Platform-specific locations:

• Linux: ~/.cache/APP_NAME (or XDG_CACHE_HOME/APP_NAME)
• macOS: ~/Library/Caches/ORG_NAME.APP_NAME
• Windows: %LOCALAPPDATA%/ORG_NAME/APP_NAME

Use for ephemeral data, caches, runtime state.

PersistentData

Cross-machine persistent application state

Platform-specific locations:

• Linux: ~/.local/share/APP_NAME (or XDG_DATA_HOME/APP_NAME)
• macOS: ~/Library/Application Support/ORG_NAME.APP_NAME
• Windows: %APPDATA%/ORG_NAME/APP_NAME

Use for persistent data that should sync across machines.

Runtime

Dynamic configuration from environment variables and CLI

Not file-based. Resolved separately via environment variables and command-line arguments. resolve_path() returns None for this scope.

Implementations

impl ConfigScope

pub fn name(self) -> &'static str

Returns a human-readable name for this scope

Example

assert_eq!(ConfigScope::Preferences.name(), "Preferences");
assert_eq!(ConfigScope::UserGlobal.name(), "UserGlobal");

pub fn is_file_based(self) -> bool

Returns true if this scope is file-based

Returns false for Runtime scope which is handled via env vars + CLI.

Example

assert!(ConfigScope::Preferences.is_file_based());
assert!(!ConfigScope::Runtime.is_file_based());

Trait Implementations

impl Clone for ConfigScope

fn clone(&self) -> ConfigScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigScope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigScope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ConfigScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConfigScope

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ConfigScope

impl Eq for ConfigScope

impl StructuralPartialEq for ConfigScope