Struct Secret 

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

Wraps a value that should never appear formatted with Display or Debug in logs or other output.

Secret<T> does implement Debug, but only outputs the inner type name, ie. "Secret<String>";

Forwards the following core traits from its inner type:

• Clone
• Copy
• PartialeEq
• Eq
• PartialOrd
• Ord

Feature-flagged trait implementations

Feature	Trait
core	Debug (1)
core	Clone (2)
core	Copy (3)
core	PartialEq
core	Eq
core	PartialOrd
core	Ord
core	Hash
serde	Serialize
serde	Deserialize
schemars	JsonSchema
sqlx	Type

All trait implementations besides Debug are forwarded from the inner type.

1. Debug::fmt only produces the name of the wrapped type, ie. "Secret<&str>"
2. T::Clone enables the expose_clone(&self) -> T method of Secret<T>
3. T::Copy enables the expose_copy(&self) -> T method of Secret<T>

Implementations

impl<T> Secret<T>

pub fn new(value: T) -> Self

pub fn expose(self) -> T

pub fn expose_ref(&self) -> &T

impl<T: Clone> Secret<T>

pub fn expose_clone(&self) -> T

impl<T: Copy> Secret<T>

pub fn expose_copy(&self) -> T

Trait Implementations

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

fn clone(&self) -> Self

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

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn from(value: T) -> Self

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

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl<T: Ord> Ord for Secret<T>

fn cmp(&self, other: &Self) -> 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> PartialEq for Secret<T>

fn eq(&self, other: &Self) -> 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> PartialOrd for Secret<T>

fn partial_cmp(&self, other: &Self) -> 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: Serialize> 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.

impl<T: Copy> Copy for Secret<T>

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