Struct Secret 

pub struct Secret { /* private fields */ }

A secure secret wrapper that provides memory safety guarantees.

• Implements Zeroize for secure memory cleanup on drop
• Debug output shows [REDACTED] instead of the actual value
• Uses SecretString from the secrecy crate for the underlying storage

Implementations

impl Secret

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

Create a new secret from a string value.

pub fn expose(&self) -> &str

Expose the secret value for use.

This should only be called when the secret value is actually needed, such as when passing to an external service or writing to an encrypted store.

pub fn as_secret_string(&self) -> &SecretBox<str>

Get the underlying SecretString reference.

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<(), Error>

Formats the value using the given formatter.

impl From<&str> for Secret

fn from(value: &str) -> Secret

Converts to this type from the input type.

impl From<SecretBox<str>> for Secret

fn from(value: SecretBox<str>) -> Secret

Converts to this type from the input type.

impl From<String> for Secret

fn from(value: String) -> Secret

Converts to this type from the input type.

impl Zeroize for Secret

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.