Skip to main content

FileCascadeEnv

Struct FileCascadeEnv 

Source
#[non_exhaustive]
pub struct FileCascadeEnv { pub claude_config_dir: Option<PathBuf>, pub xdg_config_home: Option<PathBuf>, pub home: Option<PathBuf>, }
Expand description

Environmental inputs for the file-cascade portion of credential resolution. macOS Keychain probes shell out to security and don’t depend on these fields, so only the file-cascade env vars live here. Treats empty string as unset per credentials.md §Edge cases.

Built once at the call boundary — driver.rs and lib.rs::run_* pull from process env via Self::from_process_env; doctor builds via the same factory; tests construct directly. The cascade itself never touches std::env.

Construction safety: prefer Self::new or Self::from_process_env over struct-literal construction. Both constructors enforce the empty-string-as-unset invariant; direct field assignment trusts the caller. An empty PathBuf ("") passed in via direct construction would make the cascade walk "".join(".credentials.json") = ".credentials.json" (a CWD-relative path), which try_file_cascade_with would then stat against whatever directory the binary happened to launch in. That’s a security-relevant footgun for a credential resolver — use the constructors.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§claude_config_dir: Option<PathBuf>

$CLAUDE_CONFIG_DIR.

§xdg_config_home: Option<PathBuf>

$XDG_CONFIG_HOME.

§home: Option<PathBuf>

$HOME.

Implementations§

Source§

impl FileCascadeEnv

Source

pub fn new( claude_config_dir: Option<OsString>, xdg_config_home: Option<OsString>, home: Option<OsString>, ) -> Self

Build a FileCascadeEnv with empty-string-as-unset normalization. Pass None for “unset”; pass Some(path) for “set to this value.” Empty-string OsString values collapse to None per credentials.md §Edge cases.

Source

pub fn from_process_env() -> Self

Snapshot the three relevant env vars from the process via var_os so non-UTF-8 values (Unix byte-string paths) survive through to the cascade. Empty strings collapse to None. Used by the bare resolve_credentials wrapper; explicit-env callers go through Self::new.

Trait Implementations§

Source§

impl Clone for FileCascadeEnv

Source§

fn clone(&self) -> FileCascadeEnv

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 FileCascadeEnv

Source§

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

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

impl Default for FileCascadeEnv

Source§

fn default() -> FileCascadeEnv

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.