Struct SecretString 

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

A string that cannot be printed by accident.

Debug and Display both render ***, and there is deliberately no Serialize: a payload that genuinely needs the value asks for it with SecretString::expose_secret, which is greppable in review in a way that format!("{value}") is not.

Implementations

impl SecretString

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

pub fn expose_secret(&self) -> &str

The value itself. Call this at the boundary that needs it — the header being signed, the connection being opened — and nowhere else.

pub fn is_empty(&self) -> bool

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Eq for SecretString

impl From<String> for SecretString

fn from(value: String) -> Self

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