Skip to main content

EnvironmentConfig

Struct EnvironmentConfig 

Source
pub struct EnvironmentConfig {
    pub auths_home: Option<PathBuf>,
    pub keychain: KeychainConfig,
    pub ssh_agent_socket: Option<PathBuf>,
}
Expand description

Full environment configuration for an Auths process.

Collect all environment-variable inputs at the process boundary (main, FFI entry) and thread this struct through the call graph. Subsystems accept &EnvironmentConfig instead of reading env vars directly.

Usage:

let env = EnvironmentConfig::from_env();
let home = auths_home_with_config(&env)?;
let keychain = get_platform_keychain_with_config(&env)?;

Fields§

§auths_home: Option<PathBuf>

Override for the Auths home directory (AUTHS_HOME). None falls back to ~/.auths.

§keychain: KeychainConfig

Keychain backend settings.

§ssh_agent_socket: Option<PathBuf>

Path to the SSH agent socket (SSH_AUTH_SOCK).

Implementations§

Source§

impl EnvironmentConfig

Source

pub fn from_env() -> Self

Build an EnvironmentConfig from the process environment.

Reads AUTHS_HOME, AUTHS_KEYCHAIN_BACKEND, AUTHS_KEYCHAIN_FILE, AUTHS_PASSPHRASE, and SSH_AUTH_SOCK.

Usage:

let env = EnvironmentConfig::from_env();
Source

pub fn builder() -> EnvironmentConfigBuilder

Returns a builder for constructing test configurations without env vars.

Usage:

let env = EnvironmentConfig::builder()
    .auths_home(temp_dir.path().to_path_buf())
    .build();

Trait Implementations§

Source§

impl Clone for EnvironmentConfig

Source§

fn clone(&self) -> EnvironmentConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnvironmentConfig

Source§

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

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

impl Default for EnvironmentConfig

Source§

fn default() -> EnvironmentConfig

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V