Struct Redactor 

pub struct Redactor { /* private fields */ }

Two-phase redactor: mark areas, then apply.

Implementations

impl Redactor

pub fn new() -> Self

Create a new empty redactor.

pub fn mark(&mut self, area: RedactionArea)

Mark an area for redaction.

pub fn mark_all(&mut self, areas: impl IntoIterator<Item = RedactionArea>)

Mark multiple areas for redaction.

pub fn pending_count(&self) -> usize

Return the number of pending redaction areas.

pub fn apply(&self, doc: &mut Document) -> Result<RedactionReport>

Apply all pending redactions to the document.

This permanently removes content in the marked areas, draws overlay rectangles, and cleans document metadata.

Each area is in the page’s default user space (the coordinate system of the page’s content before any cm). Content counts as under an area where it is drawn, after the current transformation matrix, the text matrix and any Form XObject /Matrix have been applied:

• glyphs under an area are removed one by one; the glyphs around them keep their positions;
• a path that touches an area is removed whole (a clipping path keeps its clip and loses only its painting);
• an image or inline image that touches an area is replaced by a black image of the same placement;
• a Form XObject under an area is filtered the same way. A form that is also drawn elsewhere is copied first, so other pages and other placements keep the original;
• replacement text (/ActualText, /Alt, /E) on marked content that lost something is removed with it.

Objects the rewrite no longer uses are dropped, so a full save writes none of the removed content. An incremental save would keep the earlier revision: save the result with a full rewrite.

Errors

Returns an error, and leaves doc unchanged, when a redacted page contains something the filter cannot place: text in a Type3 font, vertical writing, a content stream it cannot decode or parse, a Form XObject that draws itself, or an image in a filter listed under RedactError::UnsupportedImageFilter. It never reports success over content it did not process.

Trait Implementations

impl Debug for Redactor

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

Formats the value using the given formatter.

impl Default for Redactor

fn default() -> Self

Returns the “default value” for a type.