Enum MaybeSecret

pub enum MaybeSecret<T: Zeroize> {
    Secret(String),
    Plain(Zeroizing<T>),
}

A type that is either a reference to a secret, serialized as a URI string like secrets://, or a plain literal.

Variants

Secret(String)

Plain(Zeroizing<T>)

Implementations

impl<T: Zeroize> MaybeSecret<T>

pub fn key(&self) -> Option<String>

pub fn secret<S: AsRef<str>>(key: S) -> Self

pub fn plain(t: T) -> Self

impl<T: Clone + Zeroize> MaybeSecret<T>

pub fn to_plain(&self) -> Option<Zeroizing<T>>

Trait Implementations

impl<T: Clone + Zeroize> Clone for MaybeSecret<T>

fn clone(&self) -> MaybeSecret<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Zeroize> Debug for MaybeSecret<T>

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

Formats the value using the given formatter.

impl<'de, T: DeserializeOwned + FromStr + Zeroize> Deserialize<'de> for MaybeSecret<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display + Serialize + Zeroize> Display for MaybeSecret<T>

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

Formats the value using the given formatter.

impl<T: FromStr + Zeroize> FromStr for MaybeSecret<T>

type Err = <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: Serialize + Zeroize + JsonSchema> JsonSchema for MaybeSecret<T>

fn schema_name() -> String

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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

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

impl<T: PartialEq + Zeroize> PartialEq for MaybeSecret<T>

fn eq(&self, other: &MaybeSecret<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: Serialize + Zeroize> Serialize for MaybeSecret<T>

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

Serialize this value into the given Serde serializer.

impl<T: Zeroize> Zeroize for MaybeSecret<T>

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: Eq + Zeroize> Eq for MaybeSecret<T>

impl<T: Zeroize> StructuralPartialEq for MaybeSecret<T>