Struct SecretString 

pub struct SecretString { /* private fields */ }

A string wrapper that prevents accidental secret exposure in logs or config dumps.

Use SecretString::expose to access the plaintext intentionally.

Implementations

impl SecretString

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

Create a new secret from a plaintext value.

pub fn expose(&self) -> &str

Return the plaintext value.

pub const fn is_empty(&self) -> bool

Return true if the underlying value is empty.

pub const fn len(&self) -> usize

Return the length of the underlying value.

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<'de>>(de: D) -> Result<Self, D::Error>

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

impl PartialEq for SecretString

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SecretString

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

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.