Struct RedactionInspection 

pub struct RedactionInspection { /* private fields */ }

Highest sensitivity found by one complete, bounded inspection.

A successful value proves the complete admitted input was classified. None from Self::max_sensitivity therefore means no inspected value was declared sensitive. 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

impl RedactionInspection

pub const fn contains_sensitive(&self) -> bool

Reports whether the complete traversal found sensitive data.

pub const fn is_redaction_disabled(&self) -> bool

Returns whether redaction was globally disabled for this inspection.

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

Returns the strongest sensitivity found by the complete traversal.

Returns

Some(level) for sensitive data, or None when the complete input was classified as plain.

pub const fn usage(&self) -> RedactionUsage

Returns resources consumed while classifying the input.

Output bytes are always zero because inspection never renders values.

Trait Implementations

impl Clone for RedactionInspection

fn clone(&self) -> RedactionInspection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RedactionInspection

impl Debug for RedactionInspection

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

Formats the value using the given formatter.

impl Eq for RedactionInspection

impl PartialEq for RedactionInspection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionInspection