Enum AppRootPolicy 

#[non_exhaustive]
pub enum AppRootPolicy {
    PlatformDefault,
    EnvironmentOverride {
        variable: String,
    },
    Explicit {
        path: PathBuf,
    },
}

How to choose the application root.

Does not hardcode product environment variables; callers pass the variable name.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PlatformDefault

Use platform-native application directories (dirs).

EnvironmentOverride

Prefer an environment variable when set and non-empty; else platform default.

Fields

variable: String

Name of the environment variable (not its value).

Explicit

Use an explicit root path (expanded/normalized by the caller or this API).

Fields

path: PathBuf

Explicit application root.

Trait Implementations

impl Clone for AppRootPolicy

fn clone(&self) -> AppRootPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppRootPolicy

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

Formats the value using the given formatter.

impl Eq for AppRootPolicy

impl PartialEq for AppRootPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AppRootPolicy