Struct Secret 

pub struct Secret(String);

Secure string wrapper with automatic memory zeroization.

Wraps a String and ensures the memory is zeroized when dropped, preventing sensitive data (like passphrases) from remaining in memory.

Security

When this struct is dropped, the underlying string bytes are overwritten with zeros before being deallocated.

Examples

let secret = Secret::new("my_passphrase".to_string());
// Memory will be zeroized when secret goes out of scope

Tuple Fields

0: String

Implementations

impl Secret

pub fn new(v: String) -> Self

Create a new secret from a string.

Arguments

• v - The secret value to wrap

Examples

let secret = Secret::new("password123".to_string());

pub fn as_str(&self) -> &str

Get a string slice of the secret value.

Returns

A reference to the inner string.

Security Warning

The returned reference does not have the same zeroization guarantees as the Secret struct itself. Avoid storing this reference or creating copies of the data.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Drop for Secret

Implement Drop to ensure memory is zeroized when the secret is dropped.

fn drop(&mut self)

Executes the destructor for this type.