# Struct Secret

Source

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

Expand description

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§

Source§

### impl<T> Secret<T>

Source

#### pub fn expose(self) -> T

Unwraps the contained value.

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

Source

#### 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();

Source

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

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

Source

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

Source§

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

Source

#### 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();

Source§

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

Source

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

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

Source§

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

Source

#### pub fn is_empty(&self) -> bool

Checks if the contained value is empty.

## Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl<T> Debug for Secret<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

#### fn default() -> Secret<T>

Returns the “default value” for a type. Read more
Source§

### impl<'de, T> Deserialize<'de> for Secret<T>
where T: Deserialize<'de>,

Source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

#### fn from(inner: T) -> Self

Converts to this type from the input type.
Source§

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

Source§

#### fn eq(&self, other: &Secret<T>) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl<T> Serialize for Secret<T>
where T: Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Source§

### impl<T> StructuralPartialEq for Secret<T>

## Auto Trait Implementations§

§

### impl<T> Freeze for Secret<T>
where T: Freeze,

§

### impl<T> RefUnwindSafe for Secret<T>
where T: RefUnwindSafe,

§

### impl<T> Send for Secret<T>
where T: Send,

§

### impl<T> Sync for Secret<T>
where T: Sync,

§

### impl<T> Unpin for Secret<T>
where T: Unpin,

§

### impl<T> UnwindSafe for Secret<T>
where T: UnwindSafe,

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<!> for T

Source§

#### fn from(t: !) -> T

Converts to this type from the input type.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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