Struct RedactionSummary 

pub struct RedactionSummary { /* private fields */ }

Machine-readable summary of one redaction operation.

Examples

use qubit_redact::RedactionCompletion;
use qubit_redact::Redactor;

let output = Redactor::standard().redact_field("password", "raw-secret");
assert_eq!(output.summary().completion(), RedactionCompletion::Complete);
assert!(!output.summary().is_redaction_disabled());

Implementations

impl RedactionSummary

pub const fn completion(self) -> RedactionCompletion

Returns completion state.

Returns

The final completion state of the safe representation.

pub const fn is_redaction_disabled(self) -> bool

Returns whether redaction was globally disabled for this operation.

Returns

True when this operation intentionally bypassed redaction.

pub const fn reasons(self) -> RedactionReasons

Returns accumulated reasons.

Returns

All machine-readable causes retained by the operation.

pub const fn usage(self) -> RedactionUsage

Returns resource use measured by the operation that produced this summary.

Returns

The resource measurements associated with this operation.

Trait Implementations

impl Clone for RedactionSummary

fn clone(&self) -> RedactionSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RedactionSummary

impl Debug for RedactionSummary

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

Formats the value using the given formatter.

impl Eq for RedactionSummary

impl PartialEq for RedactionSummary

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionSummary