Struct RedactionUsage 

pub struct RedactionUsage { /* private fields */ }

Measured resource use for one redaction transaction.

Examples

use qubit_redact::Redactor;

let output = Redactor::standard().redact_field("id", "42");
assert_eq!(output.summary().usage().inspected_input_bytes(), 4);
assert_eq!(output.summary().usage().output_bytes(), 2);

Implementations

impl RedactionUsage

pub const fn empty() -> Self

Creates an empty measurement for a newly started transaction.

Returns

An empty measurement with all counters zero and known zero omissions.

pub const fn presented_input_bytes(self) -> usize

Returns the bytes supplied by callers before input admission.

Returns

Bytes presented at admitted or rejected public input boundaries.

pub const fn inspected_input_bytes(self) -> usize

Returns the bytes the transaction actually inspected.

Returns

Source bytes successfully admitted for inspection, even if later discarded.

pub const fn output_bytes(self) -> usize

Returns the final escaped bytes retained by the transaction.

Returns

Escaped bytes retained in the completed text or batch output.

pub const fn visited_nodes(self) -> usize

Returns the admitted domain or format nodes visited by the transaction.

Returns

Structural nodes successfully admitted during traversal.

pub const fn visited_collection_items(self) -> usize

Returns the admitted collection items visited by the transaction.

Returns

Sequence and map entries successfully admitted during traversal.

pub const fn max_depth(self) -> usize

Returns the greatest active structural depth observed by the transaction.

Returns

The greatest active structural depth, or zero when no node was admitted.

pub const fn omitted_input_bytes(self) -> Option<usize>

Returns omitted source bytes when the source length is known.

Returns

Some(bytes) counts known omissions; None means at least one source had unknown total length, so the aggregate omission is unknown.

Trait Implementations

impl Clone for RedactionUsage

fn clone(&self) -> RedactionUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RedactionUsage

impl Debug for RedactionUsage

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

Formats the value using the given formatter.

impl Default for RedactionUsage

fn default() -> Self

Creates the empty resource measurement used by a fresh transaction.

Returns

An empty measurement with all counters zero and known zero omissions.

impl Eq for RedactionUsage

impl PartialEq for RedactionUsage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionUsage