Enum OutputQuality 

pub enum OutputQuality {
    Exact,
    BestEffort,
    Sandboxed,
}

Fidelity level of the flattened output relative to the source XFA data.

Variants

Exact

All data was bound and rendered without skipping any scripts or content.

BestEffort

Some scripts were skipped (e.g. JavaScript with BestEffortStatic mode); output may differ from a full Adobe Reader render.

Sandboxed

All JavaScript scripts on the document executed inside the sandbox without runtime / timeout / OOM errors (requires xfa-js-sandboxed feature).

Implementations

impl OutputQuality

pub fn as_str(self) -> &'static str

Return a short lowercase string label suitable for logging and metrics.

Examples found in repository

examples/flatten_xfa.rs (line 55)

fn main() -> Result<(), Box<dyn Error>> {
    let args: Vec<String> = std::env::args().collect();
    if args.len() < 3 {
        eprintln!("usage: flatten_xfa <input.pdf> <output.pdf>");
        std::process::exit(1);
    }

    let input = PathBuf::from(&args[1]);
    let output = PathBuf::from(&args[2]);

    let pdf_bytes =
        std::fs::read(&input).map_err(|e| format!("failed to read {}: {e}", input.display()))?;

    // Early check: encrypted PDFs cannot be flattened without a password.
    if pdf_xfa::is_pdf_encrypted(&pdf_bytes) {
        eprintln!(
            "SKIP: {} is encrypted — supply a decrypted copy",
            input.display()
        );
        std::process::exit(2);
    }

    let (flattened, metadata) = pdf_xfa::flatten_xfa_to_pdf_with_metadata(&pdf_bytes)
        .map_err(|e| format!("flatten failed: {e}"))?;

    std::fs::write(&output, &flattened)
        .map_err(|e| format!("failed to write {}: {e}", output.display()))?;

    // Count pages in the output using lopdf.
    let page_count = count_pages(&flattened).unwrap_or(0);

    println!(
        "Flattened {} -> {} ({page_count} page{}, quality: {})",
        input.display(),
        output.display(),
        if page_count == 1 { "" } else { "s" },
        metadata.output_quality.as_str(),
    );

    Ok(())
}

Trait Implementations

impl Clone for OutputQuality

fn clone(&self) -> OutputQuality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputQuality

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

Formats the value using the given formatter.

impl Default for OutputQuality

fn default() -> OutputQuality

Returns the “default value” for a type.

impl PartialEq for OutputQuality

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for OutputQuality

impl Eq for OutputQuality

impl StructuralPartialEq for OutputQuality