Struct abscissa_core::Secret

pub struct Secret<S> where
    S: Zeroize,  { /* fields omitted */ }

Wrapper type for values that contains secrets, which attempts to limit accidental exposure and ensure secrets are wiped from memory when dropped. (e.g. passwords, cryptographic keys, access tokens or other credentials)

Access to the secret inner value occurs through the ExposeSecret trait, which provides an expose_secret() method for accessing the inner secret value.

Methods

impl<S> Secret<S> where
    S: Zeroize, 

pub fn new(secret: S) -> Secret<S>

Take ownership of a secret value

Trait Implementations

impl<S> Clone for Secret<S> where
    S: CloneableSecret, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Secret<S> where
    S: Zeroize + DebugSecret, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Secret<T> where
    T: Zeroize + Clone + DebugSecret + DeserializeOwned, 

fn deserialize<D>(
    deserializer: D
) -> Result<Secret<T>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S> Drop for Secret<S> where
    S: Zeroize, 

fn drop(&mut self)

Executes the destructor for this type.

impl<S> ExposeSecret<S> for Secret<S> where
    S: Zeroize, 

fn expose_secret(&self) -> &S

Expose secret

impl FromStr for Secret<String>

type Err = ()

The associated error which can be returned from parsing.

fn from_str(
    src: &str
) -> Result<Secret<String>, <Secret<String> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<T> Serialize for Secret<T> where
    T: Zeroize + DebugSecret + Serialize, 

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

Serialize this value into the given Serde serializer.