Struct Secret

pub struct Secret<T> {
    inner: T,
}

A wrapper for values that should not be printed.

This type does not implement Display, and has a Debug impl that hides the contained value.

let token = Secret::from("super secret string");
assert_eq!(format!("{:?}", token), "Secret { inner: \"REDACTED\" }");

Currently, we write a borrowed Secret<T> as Secret<&T>. The as_deref and to_owned methods can be used to convert back and forth between Secret<String> and Secret<&str>.

Fields

inner: T

Implementations

impl<T> Secret<T>

pub fn expose(self) -> T

Unwraps the contained value.

Use of this method marks the boundary of where the contained value is hidden.

pub fn as_deref(&self) -> Secret<&<T as Deref>::Target>

where T: Deref,

Converts a Secret<T> to a Secret<&T::Target>.

let owned: Secret<String> = Secret::from(String::from("token"));
let borrowed: Secret<&str> = owned.as_deref();

pub fn as_ref(&self) -> Secret<&T>

Converts a Secret<T> to a Secret<&T>.

pub fn map<U, F>(self, f: F) -> Secret<U>

where F: FnOnce(T) -> U,

Converts a Secret<T> to a Secret<U> by applying f to the contained value.

impl<T: ToOwned + ?Sized> Secret<&T>

pub fn to_owned(&self) -> Secret<<T as ToOwned>::Owned>

Converts a Secret containing a borrowed type to a Secret containing the corresponding owned type.

let borrowed: Secret<&str> = Secret::from("token");
let owned: Secret<String> = borrowed.to_owned();

impl<T, E> Secret<Result<T, E>>

pub fn transpose(self) -> Result<Secret<T>, E>

Converts a Secret<Result<T, E>> to a Result<Secret<T>, E>.

impl<T: AsRef<str>> Secret<T>

pub fn is_empty(&self) -> bool

Checks if the contained value is empty.

Trait Implementations

impl<T: Clone> Clone for Secret<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Secret<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Secret<T>

fn default() -> Secret<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Secret<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for Secret<T>

fn from(inner: T) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Secret<T>

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

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Secret<T>

impl<T> StructuralPartialEq for Secret<T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.