Struct SecretString 

pub struct SecretString(/* private fields */);

Opaque string that redacts its contents in Debug, Display, and Serialize.

Implementations

impl SecretString

pub fn new(value: impl Into<String>) -> Result<Self, FieldError>

Wrap value without further validation.

pub fn into_inner(self) -> String

Unwrap the inner string.

pub fn expose_secret(&self) -> &str

Borrow the secret in plaintext.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretString

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

Formats the value using the given formatter.

impl Dump for SecretString

fn serialize_dump<S: Serializer>( &self, serializer: S, opts: &DumpOptions, ) -> Result<S::Ok, S::Error>

Serialize directly when supported, preserving dump semantics.

fn dump(&self, opts: &DumpOptions) -> Result<Value, DumpError>

Serialize with opts applied.

impl Eq for SecretString

impl PartialEq for SecretString

fn eq(&self, other: &SecretString) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Schema for SecretString

fn schema(_: &mut SchemaRegistry) -> SchemaObject

The schema definition of this type. Use SchemaRegistry::subschema for nested types.

fn schema_name() -> Option<&'static str>

Stable component name. Named types are emitted once under components.schemas and referenced with $ref.

impl Serialize for SecretString

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretString

impl TryFrom<String> for SecretString

type Error = FieldError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Validate for SecretString

fn prepare(input: &mut Value, ctx: &mut ValidationContext)

Check and normalise the raw input for this type in place.

fn validate(&self, _ctx: &mut ValidationContext)

Check invariants of the deserialized value.