Enum ConfigPath 

pub enum ConfigPath {
    Default(PathBuf),
    Override(PathBuf),
}

A resolved config-related file path that records whether it came from a CLI override or from the default location under config_home.

Origin is part of the type so loaders can decide whether missing files should error (override) or be scaffolded (default) without a parallel bool.

Examples

use nu_config::ConfigPath;
use std::path::PathBuf;

let default = ConfigPath::Default(PathBuf::from("/home/me/.config/nushell/config.nu"));
assert!(!default.is_override());

let r#override = ConfigPath::Override(PathBuf::from("/tmp/custom.nu"));
assert!(r#override.is_override());
assert_eq!(r#override.as_path(), PathBuf::from("/tmp/custom.nu"));

Variants

Default(PathBuf)

Path derived from the resolved config home (e.g. config_home/config.nu). First-run scaffolding is allowed when the file is missing.

Override(PathBuf)

Path supplied by a CLI flag (--config, --env-config, --plugin-config). A missing file is an error; do not scaffold.

Implementations

impl ConfigPath

pub fn as_path(&self) -> &Path

The concrete filesystem path.

pub fn to_path_buf(&self) -> PathBuf

Owned copy of the concrete filesystem path.

pub fn into_path_buf(self) -> PathBuf

Consume and return the concrete filesystem path.

pub fn is_override(&self) -> bool

Whether this path came from a CLI override.

pub fn empty_default() -> Self

Empty default path — used only for inert pre-resolve state (NushellConfigDirs::empty).

Trait Implementations

impl AsRef<Path> for ConfigPath

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ConfigPath

fn clone(&self) -> ConfigPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigPath

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

Formats the value using the given formatter.

impl Display for ConfigPath

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

Formats the value using the given formatter.

impl Eq for ConfigPath

impl PartialEq for ConfigPath

fn eq(&self, other: &ConfigPath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConfigPath