Struct SecretString 

pub struct SecretString(/* private fields */);

A string wrapper that masks its value when printed via Debug or Display, to prevent secrets (API keys, tokens, passwords, …) from accidentally ending up in logs or error messages.

The real value is still accessible via SecretString::expose_secret, and is preserved (not masked) when (de)serialized with serde, since serialization is generally used to persist or transmit the value rather than to display it.

This is the Rust analogue of upstream’s SecretString(str), which masks its repr() but not its str()/__format__ behavior. Rust has no implicit string-like coercions, so the equivalent masked-only surface is Debug and Display; call SecretString::expose_secret whenever the real value is needed (e.g. to authenticate a request).

Implementations

impl SecretString

pub fn new(value: impl Into<String>) -> SecretString

Wrap value as a SecretString.

pub fn expose_secret(&self) -> &str

Return the real, unmasked value.

Named to match upstream’s get_secret_value() / the common Rust secrecy-crate convention, and to make call sites grep-able for audits of where secrets are actually exposed.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretString

fn deserialize<__D>( __deserializer: __D, ) -> Result<SecretString, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Eq for SecretString

impl From<&str> for SecretString

fn from(value: &str) -> SecretString

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> SecretString

Converts to this type from the input type.

impl PartialEq for SecretString

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SecretString

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.