Struct SecretString 

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

A string holding a sensitive value whose contents are never shown by Debug or Display.

The inner value is accessible only via SecretString::expose. Equality is provided for tests and lookup bookkeeping; it is not constant-time and must not be used to compare secrets that an attacker can influence by timing — compare derived crate::hashing::LookupKey values instead.

Implementations

impl SecretString

pub fn new(value: String) -> Self

Wrap a value as a secret. The value is moved in and never copied to any formatting buffer.

pub fn expose(&self) -> &str

Borrow the plaintext. Named expose so its use is visible in review and easy to grep for; callers must not log or persist the returned value.

pub fn len(&self) -> usize

Number of bytes in the underlying value. Length is not considered sensitive for the fixed-width secrets codlet generates.

pub fn is_empty(&self) -> bool

Whether the underlying value is empty.

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

Formats the value using the given formatter.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Eq for SecretString

impl PartialEq for SecretString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SecretString