Struct sec::Secret

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

Wraps a type T, preventing it from being accidentally revealed.

Implementations

impl Secret<String>

pub fn as_str(&self) -> Secret<&str>

Returns a str reference, wrapped in a secret

pub fn reveal_str(&self) -> &str

Return and reveal a str reference.

impl<T> Secret<T>

pub fn new(val: T) -> Secret<T>

Creates a new secret

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

Create a secret immutable reference

pub fn as_mut(&mut self) -> Secret<&mut T>

Create a secret mutable reference

pub fn reveal(&self) -> &T

Reveal the held value by returning a reference

pub fn reveal_into(self) -> T

Reveal the held value by unwrapping

pub fn map_revealed<V, F: FnOnce(T) -> V>(self, f: F) -> Secret<V>

Reveals the held value by applying a function to it

Trait Implementations

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

fn clone(&self) -> Self

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>> Deserialize<'de> for Secret<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Secret<T>

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

Formats the value using the given formatter.

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

fn from(v: T) -> Secret<T>

Converts to this type from the input type.

impl<T: Hash> Hash for Secret<T>

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: 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: Copy> Copy for Secret<T>

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

impl<T: Send> Send for Secret<T>

impl<T: Sync> Sync for Secret<T>