Enum SecretRef 

pub enum SecretRef {
    Env(String),
    Keychain {
        service: String,
        account: String,
    },
    File(PathBuf),
    Cmd(String),
}

Variants

Env(String)

Keychain

Fields

service: String

account: String

File(PathBuf)

Cmd(String)

Implementations

impl SecretRef

pub async fn resolve(&self) -> Result<SecretString, SecretError>

pub async fn check(&self) -> bool

Probe whether the secret resolves successfully without surfacing the value. Used by GUI/CLI status indicators. Note: for Cmd refs this actually runs the command, which may have side effects or be slow.

pub async fn resolve_to_string(&self) -> Option<String>

Resolve and expose the secret as a plain String for callers that must hand the raw value to an external API (e.g. an Authorization: Bearer header). This is the deliberate materialization boundary — keep the returned value short-lived and never log or persist it. Returns None on any resolution failure (missing env var, keychain entry, etc.).

pub fn resolve_blocking(&self) -> Result<SecretString, SecretError>

Synchronous resolve for callers outside an async context (CLI factories, config loaders). Inside a multi-thread tokio runtime it uses block_in_place; otherwise it spins a current-thread runtime.

pub fn resolve_to_string_blocking(&self) -> Option<String>

Blocking analogue of resolve_to_string — same materialization caveats apply.

Trait Implementations

impl Clone for SecretRef

fn clone(&self) -> SecretRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretRef

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for SecretRef

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

Formats the value using the given formatter.

impl Eq for SecretRef

impl FromStr for SecretRef

type Err = SecretError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SecretRef

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SecretRef

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretRef