PdfElixide.RedactionReport (pdf_elixide v0.23.0)

Copy Markdown View Source

What a destructive redaction removed, returned by PdfElixide.Editor.apply_redactions/1,2.

A redaction that matched nothing returns a report of zeros rather than an error, so this is the only evidence that the pass did work. Check :glyphs_removed before trusting that a document was redacted.

Counts cover every page the pass touched, not one page — including a page that was marked or queued before PdfElixide.Editor.delete_page/2 removed it, which the pass still processes and the written document does not carry.

Summary

Types

t()

@type t() :: %PdfElixide.RedactionReport{
  bytes_removed: non_neg_integer(),
  glyphs_removed: non_neg_integer(),
  regions: non_neg_integer()
}