Struct SecretString 

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

A header value that is never rendered by Debug or Display.

Redaction is a property of this type rather than of each container, so every struct that derives Debug inherits it without a rule for contributors to remember.

This type deliberately does not implement serde::Serialize. Adding #[derive(Serialize)] to any struct holding one is therefore a compile error rather than a silent credential leak into a config dump, a state snapshot, or a session-persistence layer.

Implementations

impl SecretString

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

Wraps a value that must not be logged.

pub fn expose_secret(&self) -> &str

Returns the wrapped value.

This is the single grep-able point at which a secret becomes visible.

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 Eq for SecretString

impl<T> From<T> for SecretString

where T: Into<String>,

fn from(value: T) -> 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 StructuralPartialEq for SecretString