Struct SecretString 

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

An owned string that zeroizes its allocation on drop and redacts its debug output.

Serialization intentionally emits the underlying value for wire-format compatibility. Do not serialize this type into logs or other outputs where secrets must remain redacted.

Equality uses ordinary string comparison and is not constant-time. Do not use it to verify an attacker-controlled secret.

Implementations

impl SecretString

pub fn expose_secret(&self) -> &str

Exposes the secret value as a string slice.

pub fn into_inner(self) -> String

Consumes this value and returns the secret string.

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

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

Formats the value using the given formatter.

impl Default for SecretString

fn default() -> SecretString

Returns the “default value” for a type.

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.

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 Eq for SecretString

impl From<&str> for SecretString

fn from(value: &str) -> Self

Converts to this type from the input 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: &SecretString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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 StructuralPartialEq for SecretString

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.