Struct SensitiveValue 

pub struct SensitiveValue<T, P>(/* private fields */);

Wrapper for leaf values to apply a redaction policy.

For external types, implement SensitiveWithPolicy<P> in your crate and wrap the value in SensitiveValue<T, P> to apply the policy.

Serialization: when the json feature is enabled, serde::Serialize emits the raw inner value unchanged. This is intentional. If you need redacted JSON, use .redacted(), .to_redacted_output(), or redacted_json() (from RedactedJsonExt) at the logging/serialization boundary instead of serializing the wrapper directly.

Leaf values are atomic: SensitiveValue treats T as an opaque unit and does not traverse its fields.

Implementations

impl<T, P> SensitiveValue<T, P>

where T: SensitiveWithPolicy<P>, P: RedactionPolicy,

pub fn redacted(&self) -> String

Returns the redacted string representation using the policy P.

impl<T, P> SensitiveValue<T, P>

pub fn expose(&self) -> &T

Explicitly access the inner value.

This method makes it clear in your code that you are intentionally accessing the raw sensitive value. Use with care.

pub fn expose_mut(&mut self) -> &mut T

Explicitly access the inner value mutably.

This method makes it clear in your code that you are intentionally accessing the raw sensitive value. Use with care.

pub fn into_inner(self) -> T

Consume the wrapper and return the inner value.

Trait Implementations

impl<T: Clone, P: Clone> Clone for SensitiveValue<T, P>

fn clone(&self) -> SensitiveValue<T, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, P> Debug for SensitiveValue<T, P>

where T: SensitiveWithPolicy<P>, P: RedactionPolicy,

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

Formats the value using the given formatter.

impl<T: Default, P: Default> Default for SensitiveValue<T, P>

fn default() -> SensitiveValue<T, P>

Returns the “default value” for a type.

impl<T, P> From<T> for SensitiveValue<T, P>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash, P: Hash> Hash for SensitiveValue<T, P>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, P: Ord> Ord for SensitiveValue<T, P>

fn cmp(&self, other: &SensitiveValue<T, P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, P: PartialEq> PartialEq for SensitiveValue<T, P>

fn eq(&self, other: &SensitiveValue<T, P>) -> 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: PartialOrd, P: PartialOrd> PartialOrd for SensitiveValue<T, P>

fn partial_cmp(&self, other: &SensitiveValue<T, P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, P> ToRedactedOutput for SensitiveValue<T, P>

where T: SensitiveWithPolicy<P>, P: RedactionPolicy,

fn to_redacted_output(&self) -> RedactedOutput

impl<T: Eq, P: Eq> Eq for SensitiveValue<T, P>

impl<T, P> StructuralPartialEq for SensitiveValue<T, P>