Enum RedactError 

pub enum RedactError {
    Pdf(Error),
    Io(Error),
    PageOutOfRange(u32, u32),
    NoAreas,
    UnsupportedImageFilter(String),
    UnsupportedToUnicodeCMap {
        font_resource_name: String,
        reason: String,
    },
    Other(String),
}

Errors returned by the pdf-redact crate while marking or applying content redaction.

Redaction is high-stakes (compliance, legal disclosure) so each variant describes a refusal to proceed rather than a best-effort fallback. If you receive any variant, the input is left untouched.

Variants

Pdf(Error)

The underlying PDF byte stream could not be parsed.

Typically a malformed cross-reference table, a truncated stream, or an encrypted PDF that was not opened with the right password.

Io(Error)

An I/O error occurred while reading the source PDF or writing the redacted output.

PageOutOfRange(u32, u32)

The caller asked to redact a page index that does not exist in the document.

Fields: (requested_page, total_pages). Page numbers are 1-based.

NoAreas

The redaction call had no regions and no search query — nothing to remove. Returned eagerly so callers do not silently produce no-op output.

UnsupportedImageFilter(String)

An image embedded inside a redaction region uses a PDF stream filter that the redactor cannot rewrite (for example JBIG2 or some JPEG2000 profiles). The redaction is aborted because partially-stripped images would leak content. The caller can either rasterise the page before redacting or skip the affected page.

UnsupportedToUnicodeCMap

A page touched by the redaction has a /ToUnicode CMap whose shape the conservative pdf-redact parser cannot rewrite safely.

The redactor refuses to silently drop the CMap because that would break text-extraction tools downstream. The caller’s options are to rasterise the page first or to redact a different page range that does not include this font.

Fields

font_resource_name: String

The PDF resource name of the font whose CMap is unsupported, e.g. "F1".

reason: String

A human-readable reason for the parser’s refusal, e.g. "surrogate pair without continuation".

Other(String)

A non-categorised redaction failure. Reserved for cases the more specific variants do not cover; the message describes the situation.

Trait Implementations

impl Debug for RedactError

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

Formats the value using the given formatter.

impl Display for RedactError

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

Formats the value using the given formatter.

impl Error for RedactError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for RedactError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RedactError

fn from(source: Error) -> Self

Converts to this type from the input type.