Struct Secret 

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

A value that must never be stored or logged.

use agent_effects::redaction::Secret;

#[derive(serde::Serialize)]
struct Charge {
    account: String,
    card_token: Secret<String>,
}

let charge = Charge { account: "acct_1".into(), card_token: Secret::new("tok_live_x".into()) };
assert_eq!(
    serde_json::to_string(&charge).unwrap(),
    r#"{"account":"acct_1","card_token":"[REDACTED]"}"#
);
assert_eq!(format!("{:?}", charge.card_token), "[REDACTED]");
assert_eq!(charge.card_token.expose().map(String::as_str), Some("tok_live_x"));

Implementations

impl<T> Secret<T>

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

Wraps value.

pub const fn expose(&self) -> Option<&T>

The value, or None if this Secret was read back from storage, where only "[REDACTED]" was kept.

pub fn into_inner(self) -> Option<T>

The value, consuming the wrapper; None as for Self::expose.

pub const fn is_redacted(&self) -> bool

Whether the value is gone because it was read back from storage.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Secret<T>

Reading a Secret back always yields a redacted one: the value was never stored.

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

Deserialize this value from the given Serde deserializer.

impl<T> Display for Secret<T>

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

Formats the value using the given formatter.

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

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

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Secret<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Secret<T>

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

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Secret<T>