Struct SecretString

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

Implementations

impl SecretString

pub fn new(s: &str) -> Self

Creates a new SecretString from a regular string

The input string’s content is copied into secure memory and protected.

pub fn as_str<F, R>(&self, f: F) -> R

where F: FnOnce(&str) -> R,

Access the secret string content with a provided function

This method allows temporary access to the string content without creating a copy of the string.

pub fn to_str(&self) -> Zeroizing<String>

Create a temporary copy of the string content

Returns a zeroizing string that will be securely erased when dropped. Only use this when absolutely necessary as it creates a copy of the secret.

pub fn is_empty(&self) -> bool

Check if the secret string is empty

Returns true if the string contains no bytes.

pub fn has_minimum_length(&self, min_length: usize) -> bool

Check if the secret string meets a minimum length requirement

Returns true if the string has at least the specified length.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> Self

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SecretString

fn eq(&self, other: &Self) -> 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 SecretString

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

where S: Serializer,

Serialize this value into the given Serde serializer.