Struct SecretValue 

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

A secret value held in protected memory.

Wraps secrecy::SecretBox so the bytes are zeroized on drop and never appear in Debug output; there is no Display impl by design (I12). The value is reachable only via SecretValue::expose, which callers must invoke deliberately.

The serde impls (de)serialize the raw bytes and exist only so a record can be serialized into the buffer that is immediately AEAD-sealed (see crate::crypto); the plaintext serialization is never persisted or logged.

Implementations

impl SecretValue

pub fn new(bytes: Vec<u8>) -> Self

Wrap raw secret bytes.

pub fn expose(&self) -> &[u8]

Borrow the protected bytes. Use deliberately — this is the one path out.

Trait Implementations

impl Debug for SecretValue

Redacted Debug: never reveals the value (I12). No Display impl exists.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretValue

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

Deserialize this value from the given Serde deserializer.

impl From<&str> for SecretValue

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretValue

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecretValue

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 Serialize for SecretValue

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

Serialize this value into the given Serde serializer.