Struct ConfigPath

pub struct ConfigPath(pub(crate) PathBuf);

The configuration file path for the application.

If the path exists and is a file, one of the following configuration file locations is used:

• ETC_OVERRIDE_CONFIG_FILE
• RUN_OVERRIDE_CONFIG_FILE
• USR_LOCAL_OVERRIDE_CONFIG_FILE

If none of the above is found, DEFAULT_CONFIG_FILE is used (even if it doesn’t exist!).

Tuple Fields

0: PathBuf

Implementations

impl ConfigPath

pub fn new(path: PathBuf) -> Self

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 copy 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 Default for ConfigPath

fn default() -> Self

Returns the default ConfigPath.

If the path exists and is a file, one of the following configuration file locations is used:

• ETC_OVERRIDE_CONFIG_FILE
• RUN_OVERRIDE_CONFIG_FILE
• USR_LOCAL_OVERRIDE_CONFIG_FILE

If none of the above is found, DEFAULT_CONFIG_FILE is used (even if it doesn’t exist!).

impl From<PathBuf> for ConfigPath

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl FromStr for ConfigPath

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.