Struct SecretString

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

A string type that automatically zeroizes its contents when dropped.

This type ensures that sensitive data like passwords and API keys are securely erased from memory as soon as they’re no longer needed. It implements both Zeroize and ZeroizeOnDrop to guarantee secure memory cleanup.

Security

The underlying string is automatically zeroized when:

• The value is dropped
• zeroize() is called explicitly
• The value is moved

Implementations

impl SecretString

pub fn new(value: String) -> Self

Creates a new SecretString with the given value.

The value will be automatically zeroized when the SecretString is dropped.

pub fn as_str(&self) -> &str

Gets a reference to the underlying string.

Security Note

Be careful with this method as it exposes the secret value. The reference should be used immediately and not stored.

Trait Implementations

impl AsRef<str> for SecretString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a copy 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<'de> Deserialize<'de> for SecretString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretString

fn drop(&mut self)

Executes the destructor for this type.

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: &Self) -> 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 Serialize for SecretString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.