Struct GSecret 

pub struct GSecret<V: Validator = NoValidation, const MIN: usize = DEFAULT_MIN, const MAX: usize = DEFAULT_MAX, const ASCII_ONLY: bool = DEFAULT_ASCII_ONLY> { /* private fields */ }

GSecret is a type for containing secret.

Unlike GString, it’s not Copy for security reason.

No Display implementation and debugging is redacted.

It Implements zeroize and can be triggered manually or automatically on drop.

You can reveal the secret inside a closure to do something with it.

If you reveal and clone or take ownership of the revealed string, it goes beyond responsibility of GSecret to zeroize it.

Implementations

impl GSecret

pub fn try_default<S>(secret: S) -> Result<Self, GStringError<Infallible>>

where S: AsRef<str>,

Construct GSecret with default generic params.

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> GSecret<V, MIN, MAX, ASCII_ONLY>

pub fn try_new<S>(secret: S) -> Result<Self, GStringError<V::Err>>

where S: AsRef<str>,

Construct GSecret with defined generic params.

pub fn reveal<R>(&self, func: impl FnOnce(&str) -> R) -> R

Reveals the secret.

It’s useful if you want to do something with the secret, e.g. authentication, authorization, etc.

WARNING

Revealing the secret will expose reference to string of the secret itself. As long as you don’t bring it outside of closure scope, it’s fine. If you bring it outside, it goes beyond responsibility of GSecret to zeroize it.

pub fn zeroize(&mut self)

Manually zeroize the secret.

It’s useful if you want to zeroize before the secret is out-of-scope/dopped.

Trait Implementations

impl<V: Clone + Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Clone for GSecret<V, MIN, MAX, ASCII_ONLY>

fn clone(&self) -> GSecret<V, MIN, MAX, ASCII_ONLY>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Debug for GSecret<V, MIN, MAX, ASCII_ONLY>

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

Formats the value using the given formatter.

impl<'de, V, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Deserialize<'de> for GSecret<V, MIN, MAX, ASCII_ONLY>

where V: Validator, GStringError<V::Err>: Display,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Drop for GSecret<V, MIN, MAX, ASCII_ONLY>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> FromStr for GSecret<V, MIN, MAX, ASCII_ONLY>

type Err = GStringError<<V as Validator>::Err>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Hash for GSecret<V, MIN, MAX, ASCII_ONLY>

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<V: PartialEq + Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> PartialEq for GSecret<V, MIN, MAX, ASCII_ONLY>

fn eq(&self, other: &GSecret<V, MIN, MAX, ASCII_ONLY>) -> 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<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> TryFrom<&str> for GSecret<V, MIN, MAX, ASCII_ONLY>

type Error = GStringError<<V as Validator>::Err>

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<GSTRINGV: Validator, GSECRETV: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> TryFrom<GString<GSTRINGV, MIN, MAX, ASCII_ONLY>> for GSecret<GSECRETV, MIN, MAX, ASCII_ONLY>

type Error = GStringError<<GSECRETV as Validator>::Err>

The type returned in the event of a conversion error.

fn try_from( value: GString<GSTRINGV, MIN, MAX, ASCII_ONLY>, ) -> Result<Self, Self::Error>

Performs the conversion.

impl<V, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> TryFrom<String> for GSecret<V, MIN, MAX, ASCII_ONLY>

where V: Validator,

Available on crate feature alloc only.

type Error = GStringError<<V as Validator>::Err>

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<V, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Zeroize for GSecret<V, MIN, MAX, ASCII_ONLY>

where V: Validator,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<V: Eq + Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> Eq for GSecret<V, MIN, MAX, ASCII_ONLY>

impl<V: Validator, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> StructuralPartialEq for GSecret<V, MIN, MAX, ASCII_ONLY>

impl<V, const MIN: usize, const MAX: usize, const ASCII_ONLY: bool> ZeroizeOnDrop for GSecret<V, MIN, MAX, ASCII_ONLY>

where V: Validator,