Struct SecretString 

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

A secret string that is securely zeroed from memory when dropped.

This type is only available when the zeroize feature is enabled. It ensures that sensitive data like passwords and tokens are overwritten with zeros when they go out of scope.

Implementations

impl SecretString

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

Create a new secret string.

pub fn expose_secret(&self) -> &str

Get the secret value.

Security

Be careful with the returned reference - avoid logging or copying the value unnecessarily.

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

Available on crate feature zeroize only.

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.

impl From<&str> for SecretString

Available on crate feature zeroize only.

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

Available on crate feature zeroize only.

fn from(s: String) -> Self

Converts to this type from the input type.

impl Zeroize for SecretString

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.