Struct SecretString 

pub struct SecretString { /* private fields */ }

A secret string that zeroes its memory on drop to reduce secret leakage.

Does not implement Clone to prevent accidental copies. Access the underlying value with SecretString::expose_secret in a short-lived context.

Implementations

impl SecretString

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

Wrap a string value as a secret

pub fn expose_secret(&self) -> &str

Access the secret value as a string slice.

Keep the borrow as short-lived as possible to limit exposure.

pub fn len(&self) -> usize

Return the length in bytes

pub fn is_empty(&self) -> bool

Return true if the secret is empty

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.