Struct Secret 

pub struct Secret<T>(/* private fields */);

A wrapper that redacts its contents in Debug logs and Serialization (UI/API), requiring explicit method calls to access the underlying value.

Implementations

impl<T> Secret<T>

pub fn new(value: T) -> Self

Creates a new Secret.

pub fn expose_secret(&self) -> &T

Explicitly exposes the secret by reference.

pub fn expose_owned_secret(self) -> T

Consumes the wrapper and returns the raw secret.

pub fn into_secret<U>(self) -> Secret<U>

where T: Into<U>,

Trait Implementations

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

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

Returns a duplicate 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> Serialize for Secret<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.