Struct SecretString 

pub struct SecretString<T>(/* private fields */)
where
    T: AsRef<str>;

A string wrapper that hides its contents when printed or formatted for debugging.

It WILL however serialize the value when using serde serialization/deserialization.

Examples

use secret_string::SecretString;
let secret = SecretString::new("my_secret_password");
assert_eq!(format!("{}", secret), "******************");
assert_eq!(format!("{:?}", secret), "SecretString(******************)");
assert_eq!(secret.value(), "my_secret_password");

Implementations

impl<T: AsRef<str>> SecretString<T>

pub fn new(s: T) -> Self

pub fn value(&self) -> &str

Returns the underlying value.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_stars(&self) -> String

Returns a string of asterisks (*) with the same length as the secret string.

pub fn as_stars_with_with_len(&self, len: usize) -> String

In case you don’t want to show the length of the secret

Trait Implementations

impl<T> Clone for SecretString<T>

where T: AsRef<str> + Clone,

fn clone(&self) -> SecretString<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: AsRef<str>> Debug for SecretString<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> Display for SecretString<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> From<T> for SecretString<T>

fn from(s: T) -> Self

Converts to this type from the input type.

impl<T> Hash for SecretString<T>

where T: AsRef<str> + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for SecretString<T>

where T: AsRef<str> + Ord,

fn cmp(&self, other: &SecretString<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for SecretString<T>

where T: AsRef<str> + PartialEq,

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

where T: AsRef<str> + PartialOrd,

fn partial_cmp(&self, other: &SecretString<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Eq for SecretString<T>

where T: AsRef<str> + Eq,

impl<T> StructuralPartialEq for SecretString<T>

where T: AsRef<str>,