Skip to main content

XdgEnv

Struct XdgEnv 

Source
#[non_exhaustive]
pub struct XdgEnv { /* private fields */ }
Expand description

Snapshot of the env vars the XDG cascade reads. Only xdg and home matter; the cascade has no other inputs.

Fields are OsString (not String) because Unix paths are byte-strings — a user with XDG_CACHE_HOME=/srv/café-bin in a non-UTF-8 locale must not silently lose their setting. None and empty-string both count as “not set” — the cascade treats them the same. The XdgEnv::from_process_env factory normalizes at the boundary so each call site doesn’t have to.

Implementations§

Source§

impl XdgEnv

Source

pub fn from_process_env() -> Self

Snapshot the three env vars from the running process, treating empty strings as unset per the XDG spec. Non-UTF-8 values are preserved; Option<OsString> carries them through to the cascade unchanged.

Source

pub fn from_os_options( xdg_cache_home: Option<OsString>, xdg_config_home: Option<OsString>, home: Option<OsString>, ) -> Self

Build an XdgEnv from raw OsString reads (the shape std::env::var_os returns). Filters empty values to None at the single normalization point.

Trait Implementations§

Source§

impl Clone for XdgEnv

Source§

fn clone(&self) -> XdgEnv

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 XdgEnv

Source§

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

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

impl Default for XdgEnv

Source§

fn default() -> XdgEnv

Returns the “default value” for a type. Read more

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Same for T

Source§

type Output = T

Should always be Self
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.