Struct Secret

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

See module level documentation

Implementations

impl<T> Secret<T>

pub const fn new(secret: T) -> Self

See module level documentation

pub fn from(secret: impl Into<T>) -> Self

pub fn try_from<U: TryInto<T>>(secret: U) -> Result<Self, Secret<U::Error>>

pub const fn expose_secret(&self) -> &T

See module level documentation

Trait Implementations

impl<T, U> Add<Secret<U>> for Secret<T>

where T: Add<U>,

type Output = Secret<<T as Add<U>>::Output>

The resulting type after applying the + operator.

fn add(self, rhs: Secret<U>) -> Self::Output

Performs the + operation.

impl<T, U> AddAssign<Secret<U>> for Secret<T>

where T: AddAssign<U>,

fn add_assign(&mut self, rhs: Secret<U>)

Performs the += operation.

impl<T, U> BitAnd<Secret<U>> for Secret<T>

where T: BitAnd<U>,

type Output = Secret<<T as BitAnd<U>>::Output>

The resulting type after applying the & operator.

fn bitand(self, rhs: Secret<U>) -> Self::Output

Performs the & operation.

impl<T, U> BitAndAssign<Secret<U>> for Secret<T>

where T: BitAndAssign<U>,

fn bitand_assign(&mut self, rhs: Secret<U>)

Performs the &= operation.

impl<T, U> BitOr<Secret<U>> for Secret<T>

where T: BitOr<U>,

type Output = Secret<<T as BitOr<U>>::Output>

The resulting type after applying the | operator.

fn bitor(self, rhs: Secret<U>) -> Self::Output

Performs the | operation.

impl<T, U> BitOrAssign<Secret<U>> for Secret<T>

where T: BitOrAssign<U>,

fn bitor_assign(&mut self, rhs: Secret<U>)

Performs the |= operation.

impl<T, U> BitXor<Secret<U>> for Secret<T>

where T: BitXor<U>,

type Output = Secret<<T as BitXor<U>>::Output>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Secret<U>) -> Self::Output

Performs the ^ operation.

impl<T, U> BitXorAssign<Secret<U>> for Secret<T>

where T: BitXorAssign<U>,

fn bitxor_assign(&mut self, rhs: Secret<U>)

Performs the ^= operation.

impl<T: Clone + ?Sized> 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 + ?Sized> 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>

Available on crate feature serde only.

This API requires the following crate features to be activated: serde

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

Deserialize this value from the given Serde deserializer.

impl<E: Error> Display for Secret<E>

Available on crate feature std only.

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

Formats the value using the given formatter.

impl<T, U> Div<Secret<U>> for Secret<T>

where T: Div<U>,

type Output = Secret<<T as Div<U>>::Output>

The resulting type after applying the / operator.

fn div(self, rhs: Secret<U>) -> Self::Output

Performs the / operation.

impl<T, U> DivAssign<Secret<U>> for Secret<T>

where T: DivAssign<U>,

fn div_assign(&mut self, rhs: Secret<U>)

Performs the /= operation.

impl<T: Dummy<U>, U> Dummy<U> for Secret<T>

Available on crate feature fake only.

fn dummy_with_rng<R: Rng + ?Sized>(config: &U, rng: &mut R) -> Self

Generate a dummy value for a given type using a random number generator.

fn dummy(config: &U) -> Self

Generate a dummy value for a type.

impl<E: Error> Error for Secret<E>

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

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

fn from(secret: Option<Secret<T>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<Secret<T>, E>> for Secret<Result<T, E>>

fn from(secret: Result<Secret<T>, E>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<Secret<T>, Secret<E>>> for Secret<Result<T, E>>

fn from(secret: Result<Secret<T>, Secret<E>>) -> Self

Converts to this type from the input type.

impl<T, E> From<Result<T, Secret<E>>> for Secret<Result<T, E>>

fn from(secret: Result<T, Secret<E>>) -> Self

Converts to this type from the input type.

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

fn from(secret: T) -> Self

Converts to this type from the input type.

impl<S: FromIterator<T>, T> FromIterator<Secret<T>> for Secret<S>

fn from_iter<I: IntoIterator<Item = Secret<T>>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: FromStr> FromStr for Secret<T>

type Err = Secret<<T as FromStr>::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<T: Hash + ?Sized> 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, U> Mul<Secret<U>> for Secret<T>

where T: Mul<U>,

type Output = Secret<<T as Mul<U>>::Output>

The resulting type after applying the * operator.

fn mul(self, rhs: Secret<U>) -> Self::Output

Performs the * operation.

impl<T, U> MulAssign<Secret<U>> for Secret<T>

where T: MulAssign<U>,

fn mul_assign(&mut self, rhs: Secret<U>)

Performs the *= operation.

impl<T> Neg for Secret<T>

where T: Neg,

type Output = Secret<<T as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T> Not for Secret<T>

where T: Not,

type Output = Secret<<T as Not>::Output>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: Ord + ?Sized> Ord for Secret<T>

fn cmp(&self, other: &Secret<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized> 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: PartialOrd + ?Sized> PartialOrd for Secret<T>

fn partial_cmp(&self, other: &Secret<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, U> Rem<Secret<U>> for Secret<T>

where T: Rem<U>,

type Output = Secret<<T as Rem<U>>::Output>

The resulting type after applying the % operator.

fn rem(self, rhs: Secret<U>) -> Self::Output

Performs the % operation.

impl<T, U> RemAssign<Secret<U>> for Secret<T>

where T: RemAssign<U>,

fn rem_assign(&mut self, rhs: Secret<U>)

Performs the %= operation.

impl<T: Serialize> SerializableSecret<T> for &Secret<T>

Available on crate feature serde only.

type Exposed<'a> = &'a T where T: 'a, Self: 'a

fn expose_via(&self, expose: impl Fn(&Secret<T>) -> &T) -> Self::Exposed<'_>

To reduce the number of functions that are able to expose secrets we require that the Secret::expose_secret function is passed in here.

impl<T: Serialize> SerializableSecret<T> for Secret<T>

Available on crate feature serde only.

type Exposed<'a> = &'a T where T: 'a

fn expose_via(&self, expose: impl Fn(&Secret<T>) -> &T) -> Self::Exposed<'_>

To reduce the number of functions that are able to expose secrets we require that the Secret::expose_secret function is passed in here.

impl<T, U> Shl<Secret<U>> for Secret<T>

where T: Shl<U>,

type Output = Secret<<T as Shl<U>>::Output>

The resulting type after applying the << operator.

fn shl(self, rhs: Secret<U>) -> Self::Output

Performs the << operation.

impl<T, U> ShlAssign<Secret<U>> for Secret<T>

where T: ShlAssign<U>,

fn shl_assign(&mut self, rhs: Secret<U>)

Performs the <<= operation.

impl<T, U> Shr<Secret<U>> for Secret<T>

where T: Shr<U>,

type Output = Secret<<T as Shr<U>>::Output>

The resulting type after applying the >> operator.

fn shr(self, rhs: Secret<U>) -> Self::Output

Performs the >> operation.

impl<T, U> ShrAssign<Secret<U>> for Secret<T>

where T: ShrAssign<U>,

fn shr_assign(&mut self, rhs: Secret<U>)

Performs the >>= operation.

impl<T, U> Sub<Secret<U>> for Secret<T>

where T: Sub<U>,

type Output = Secret<<T as Sub<U>>::Output>

The resulting type after applying the - operator.

fn sub(self, rhs: Secret<U>) -> Self::Output

Performs the - operation.

impl<T, U> SubAssign<Secret<U>> for Secret<T>

where T: SubAssign<U>,

fn sub_assign(&mut self, rhs: Secret<U>)

Performs the -= operation.

impl<T: TryZeroize> TryZeroize for Secret<T>

Available on crate feature zeroize only.

fn try_zeroize(&mut self) -> bool

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

impl<T: Zeroize + ?Sized> Zeroize for Secret<T>

Available on crate feature zeroize only.

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

impl<T: Eq + ?Sized> Eq for Secret<T>

impl<T: ?Sized> StructuralPartialEq for Secret<T>

impl<T: ZeroizeOnDrop> ZeroizeOnDrop for Secret<T>

Available on crate feature zeroize only.