Struct SecretString 

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

Zeroizing UTF-8 secret material.

Implementations

impl SecretString

pub const fn new(secret: String) -> Self

Wraps owned secret text.

pub fn from_secret(secret: &str) -> Self

Copies borrowed secret text into zeroizing storage.

pub fn expose_secret(&self) -> &str

Returns the secret text.

pub const fn is_empty(&self) -> bool

Returns whether the secret text is empty.

Trait Implementations

impl AsRef<str> for SecretString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.