Struct SecretString 

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

A String whose Debug implementation prints "<redacted>" instead of the contained value.

The serialized representation is identical to a String — the JSON wire format does not change. Read the underlying value with Self::expose or AsRef::<str>::as_ref.

Implementations

impl SecretString

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

Wrap a String so its Debug output is redacted.

pub fn expose(&self) -> &str

Return the wrapped secret. Take care not to log or otherwise expose the result — the wrapper exists specifically to make accidental disclosure harder.

pub fn into_inner(self) -> String

Consume the wrapper and return the underlying String.

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, 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: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Display also redacts. Construct an explicit log-friendly representation only via Self::expose when intentional disclosure is required.

impl Eq for SecretString

impl From<&str> for SecretString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<SecretString> for String

fn from(value: SecretString) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for SecretString

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 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 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.

impl StructuralPartialEq for SecretString