Skip to main content

SearchPath

Enum SearchPath 

Source
pub enum SearchPath {
    Platform,
    Home(&'static str),
    Cwd,
    Path(PathBuf),
    Ancestors(Boundary),
}
Expand description

Where to search for config files.

Each variant represents a source of candidate directories. The builder accepts a Vec<SearchPath> in priority-ascending order: last = highest priority.

Most variants resolve to a single directory. Ancestors expands into multiple directories by walking up from the current working directory. See the module documentation for details.

Variants§

§

Platform

Platform config directory (XDG on Linux, ~/Library/Application Support on macOS).

§

Home(&'static str)

A subdirectory under the user’s home directory, e.g. Home(".myapp").

§

Cwd

Current working directory.

§

Path(PathBuf)

An explicit absolute path.

§

Ancestors(Boundary)

Walk up from the current working directory, checking each ancestor.

Expands inline into multiple directories during resolution, ordered from shallowest (filesystem root) to deepest (CWD). This means CWD has the highest priority — a config found closer to the working directory wins.

The Boundary controls where the walk stops.

§Note

This variant is not valid as a persist_scope path because it resolves to multiple directories. Using it there produces an error.

Trait Implementations§

Source§

impl Clone for SearchPath

Source§

fn clone(&self) -> SearchPath

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SearchPath

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SearchPath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.