Struct SecretString 

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

Opaque wrapper around a secret string value.

Debug and Display both print [REDACTED] — the inner value is never exposed through formatting traits. Use expose for controlled access when constructing HTTP headers or form bodies.

On Drop the backing buffer is securely zeroed via the zeroize crate.

Implementations

impl SecretString

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

Create a new SecretString from a plain value.

pub fn expose(&self) -> &str

Provide read-only access to the underlying secret.

Callers must not log, store, or otherwise persist the returned slice.

pub fn into_inner(self) -> String

Consume self and return the underlying secret, e.g. to move it into another owned value without an extra clone.

Callers must not log, store, or otherwise persist the returned value.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> Self

Returns a duplicate 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

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.

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.