Struct SecretValue 

pub struct SecretValue {
    data: Vec<u8>,
    retrieved_at: Instant,
    expires_at: Option<Instant>,
    metadata: HashMap<String, String>,
}

A secret value retrieved from the store.

When the crypto feature is enabled, the secret data is automatically zeroed when dropped using the zeroize crate.

Fields

data: Vec<u8>

retrieved_at: Instant

expires_at: Option<Instant>

metadata: HashMap<String, String>

Implementations

impl SecretValue

pub fn new(data: Vec<u8>) -> SecretValue

Create a new secret value (non-crypto version).

pub fn from_string(s: impl Into<String>) -> SecretValue

Create a secret value from a string.

pub fn with_expiry(self, duration: Duration) -> SecretValue

Set the expiration time.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> SecretValue

Add metadata.

pub fn as_bytes(&self) -> &[u8]

Get the secret data as bytes.

pub fn as_str(&self) -> Option<&str>

Get the secret data as a string (if valid UTF-8).

pub fn is_expired(&self) -> bool

Check if the secret has expired.

pub fn age(&self) -> Duration

Get the age of this secret value.

pub fn metadata(&self) -> &HashMap<String, String>

Get metadata.

Trait Implementations

impl Debug for SecretValue

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

Formats the value using the given formatter.