Skip to main content

RedactionInspection

Struct RedactionInspection 

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

Highest sensitivity found by one complete, bounded inspection.

A successful value is conclusive under the selected policy. None from Self::max_sensitivity means no inspected value was declared sensitive; a disabled policy deliberately bypasses classification, as reported by Self::is_redaction_disabled. It does not prove that source data is inherently nonsensitive. Inconclusive traversal is returned as crate::RedactionInspectionError instead of this type.

§Examples

use qubit_redact::Redactor;
use qubit_redact::Sensitivity;

let inspection = Redactor::strict()
    .inspect_field("password", "raw-secret")
    .expect("the scalar inspection is bounded and valid");
assert_eq!(inspection.max_sensitivity(), Some(Sensitivity::Secret));

Implementations§

Source§

impl RedactionInspection

Source

pub const fn contains_sensitive(&self) -> bool

Reports whether the complete traversal found sensitive data.

§Returns

True when the complete traversal found at least one sensitive value.

Source

pub const fn is_redaction_disabled(&self) -> bool

Returns whether the selected policy disabled this inspection.

§Returns

True when policy classification was intentionally disabled for this inspection.

Source

pub const fn max_sensitivity(&self) -> Option<Sensitivity>

Returns the strongest sensitivity found by the complete traversal.

§Returns

Some(level) for declared sensitive data, or None when the selected policy declared none, including when classification was disabled.

Source

pub const fn usage(&self) -> RedactionUsage

Returns resources consumed while classifying the input.

Output bytes are always zero because inspection never renders values.

§Returns

Resources consumed during complete classification, with zero output bytes.

Trait Implementations§

Source§

impl Clone for RedactionInspection

Source§

fn clone(&self) -> RedactionInspection

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 Copy for RedactionInspection

Source§

impl Debug for RedactionInspection

Source§

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

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

impl Eq for RedactionInspection

Source§

impl PartialEq for RedactionInspection

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RedactionInspection

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.