Skip to main content

SensitivitySpec

Struct SensitivitySpec 

Source
pub struct SensitivitySpec { /* private fields */ }
Expand description

Declares which document field values observability may capture.

Drives value-suppression so observability never leaks tenant values (NFR-S2). The model is deny-by-default (opt-out): every field is treated as sensitive unless explicitly allow-listed as safe. A field added to your documents tomorrow is protected automatically, you opt specific, known-safe fields out of redaction rather than remembering to opt every risky one in.

Use SensitivitySpec::allowing to name the shape-only, non-tenant fields that are safe to capture; SensitivitySpec::all_sensitive (the default) redacts everything; SensitivitySpec::nothing_sensitive is the explicit opt-out for data that carries no tenant values at all (e.g. test fixtures).

Implementations§

Source§

impl SensitivitySpec

Source

pub fn all_sensitive() -> Self

Deny by default: every field’s value is sensitive. The safe default.

Source

pub fn allowing(safe: Vec<FieldName>) -> Self

Deny by default, except the safe fields (known shape-only / non-tenant values) which observability may capture.

Source

pub fn nothing_sensitive() -> Self

Treat nothing as sensitive. An explicit opt-out for data that carries no tenant values (e.g. test fixtures); never appropriate for tenant payloads.

Source

pub fn none() -> Self

Source

pub fn is_sensitive(&self, field: &FieldName) -> bool

Whether field’s value is sensitive (deny-by-default: sensitive unless explicitly allow-listed as safe).

Trait Implementations§

Source§

impl Clone for SensitivitySpec

Source§

fn clone(&self) -> SensitivitySpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SensitivitySpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SensitivitySpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SensitivitySpec

Source§

impl PartialEq for SensitivitySpec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SensitivitySpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.