Struct OutboundSecret 

pub struct OutboundSecret(SecretBox<str>);

A secret string that is deliberately serialized onto the wire once (e.g. a token returned to the caller from an auth endpoint).

Redacts in Debug so it never leaks into logs; its Serialize impl emits the raw value — that impl is the single intended exposure point. At a struct field, annotate with #[schema(value_type = String)] so the OpenAPI schema still reports string.

Tuple Fields

0: SecretBox<str>

Implementations

impl OutboundSecret

pub fn new(value: impl Into<String>) -> OutboundSecret

Trait Implementations

impl Clone for OutboundSecret

fn clone(&self) -> OutboundSecret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutboundSecret

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

Formats the value using the given formatter.

impl<'r> Decode<'r, Postgres> for OutboundSecret

fn decode( value: PgValueRef<'r>, ) -> Result<OutboundSecret, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<'de> Deserialize<'de> for OutboundSecret

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'q> Encode<'q, Postgres> for OutboundSecret

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf without moving self.

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl ExposeSecret<str> for OutboundSecret

fn expose_secret(&self) -> &str

Expose secret: this is the only method providing access to a secret.

impl From<String> for OutboundSecret

fn from(value: String) -> OutboundSecret

Converts to this type from the input type.

impl PgHasArrayType for OutboundSecret

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Serialize for OutboundSecret

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Type<Postgres> for OutboundSecret

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &PgTypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.