Struct RedactionReport 

pub struct RedactionReport {
    pub counts: BTreeMap<String, usize>,
    pub total: usize,
    pub mapping: Option<Vec<(String, String)>>,
}

What was redacted: one count per label (EMAIL, PHONE, a custom pattern’s name, REDACTED for deny terms), the total, and — only with RedactionOptions::return_mapping — the original → placeholder pairs. A backend that also builds docling’s item tree (DOCX, HTML) has its text redacted in both representations but counted once.

Fields

counts: BTreeMap<String, usize>

total: usize

mapping: Option<Vec<(String, String)>>

Implementations

impl RedactionReport

pub fn counts_json(&self) -> Value

The counts as a JSON object ({"EMAIL": 2, "PHONE": 1}), what the HTTP surfaces answer with — never the mapping.

Trait Implementations

impl Clone for RedactionReport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionReport

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

Formats the value using the given formatter.

impl Default for RedactionReport

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RedactionReport

impl PartialEq for RedactionReport

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionReport