Struct SecureString

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

Secure wrapper for sensitive string data that automatically zeroes memory on drop.

This wrapper ensures that sensitive authentication data is securely cleared from memory when it’s no longer needed, providing protection against memory inspection attacks.

Implementations

impl SecureString

pub fn new(value: String) -> Self

Creates a new secure string from the provided value.

pub fn as_str(&self) -> &str

Returns a reference to the inner string value.

Security Note

The returned reference should not be stored for extended periods to minimize exposure time of sensitive data.

pub fn into_string(self) -> String

Consumes the SecureString and returns the inner String.

Security Note

The caller becomes responsible for the secure handling of the returned String.

pub fn equals_str(&self, other: &str) -> bool

Checks if the secure string equals the given string slice.

This method is provided for convenient testing and comparison without exposing the internal string value.

Trait Implementations

impl Clone for SecureString

fn clone(&self) -> SecureString

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecureString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecureString

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecureString

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

Formats the value using the given formatter.

impl Drop for SecureString

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for SecureString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecureString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecureString

fn eq(&self, other: &SecureString) -> 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 Serialize for SecureString

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for SecureString

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.

impl Eq for SecureString

impl StructuralPartialEq for SecureString