Struct Secret 

pub struct Secret<T> { /* private fields */ }

A wrapper for sensitive data such as API keys.

Examples

let key = Secret::new("sk-ant-1234567890abcdef".to_string());
println!("{key:?}");   // Secret([REDACTED])
println!("{key}");     // sk-an...cdef
let header = format!("Bearer {}", key.expose());

Implementations

impl<T> Secret<T>

pub fn new(value: T) -> Self

Wraps a sensitive value.

pub fn expose(&self) -> &T

Access the underlying value. Use only in essential logic such as HTTP header generation.

pub fn expose_owned(self) -> T

Extract the value by transferring ownership.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Secret<U>

Transform the inner value.

Trait Implementations

impl<T: Clone> Clone for Secret<T>

fn clone(&self) -> Secret<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Secret<T>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Secret<String>

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

Deserialize this value from the given Serde deserializer.

impl Display for Secret<String>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Secret<T>

impl<T: Hash> Hash for Secret<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Secret<T>

fn cmp(&self, other: &Secret<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Secret<T>

fn eq(&self, other: &Secret<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Secret<T>

fn partial_cmp(&self, other: &Secret<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Secret<String>

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

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Secret<T>