Crate pdfv_core 

Public contracts for the pdfv validation engine.

The crate currently exposes the stable data model, error model, and JSON report writing spine used by later parser and validator phases.

use pdfv_core::{InputKind, InputSummary, ValidationOptions};

let options = ValidationOptions::default();
let source = InputSummary::new(InputKind::Memory, None, None);
assert!(options.report_parse_warnings);
assert_eq!(source.kind, InputKind::Memory);

Structs

AnnotationModel

Annotation dictionary model wrapper.

Assertion

Rule assertion detail.

BatchReport

Batch validation report.

BatchSummary

Batch summary counters.

BoundedText

Bounded UTF-8 text for externally supplied strings.

BuiltinProfileRepository

Built-in profile repository.

CatalogModel

Catalog model wrapper.

ContentStreamModel

Page content stream model wrapper.

DecodeParams

Structured parameters for one stream filter.

DecoderRegistry

Registry mapping PDF filter names to bounded decoders.

DetectedFlavours

Auto flavour detection result.

Dictionary

PDF dictionary.

ErrorArgument

Error template argument.

ErrorTemplate

Error template for failed assertions.

FeatureObject

One extracted validation-model object.

FeatureReport

Machine-readable read-only feature extraction report.

FlavourClaim

Recognized flavour claim extracted from XMP metadata.

FlavourDetector

Profile selector backed by XMP identification claims.

FontModel

Font dictionary model wrapper.

HtmlReportWriter

Static HTML report writer.

Identifier

Identifier text with a tight byte cap and ASCII policy.

IndirectObject

Parsed indirect object.

InputName

Bounded input name used by reader validation.

InputSummary

Input summary included in reports.

JsonReportWriter

JSON report writer.

LinkName

Validation model link name.

MaxDisplayedFailures

Maximum displayed assertion failures per rule.

MetadataModel

Metadata stream model wrapper.

MetadataRepairOptions

Options for safe metadata repair.

MetadataRepairer

Safe metadata repair facade.

ModelGraph

Document model wrapper.

NamespaceBinding

Namespace declaration retained from an XMP packet.

ObjectIdentity

Stable object identity used by traversal.

ObjectKey

Indirect PDF object key.

ObjectLocation

Object location for diagnostics.

ObjectStore

Indirect object storage keyed by object number and generation.

ObjectTypeName

Validation model object type name.

OutputIntentModel

Output intent dictionary model wrapper.

PageModel

Page dictionary model wrapper.

ParseOptions

Parser options for password-capable parsing.

ParsedDocument

Parsed PDF document produced by Parser.

Parser

M0 PDF parser.

PasswordSecret

Redacted PDF password secret.

PdfName

PDF name bytes after hash escape decoding.

PdfString

PDF string bytes.

PdfVersion

PDF version.

PolicyReport

Policy evaluation report.

PolicyRule

One bounded policy rule.

PolicyRuleResult

One policy rule result.

PolicySet

Bounded policy rules evaluated over a FeatureReport.

ProfileCatalogEntry

Profile metadata suitable for listing catalogs.

ProfileIdentity

Profile identity.

ProfileImportSummary

Summary produced by XML profile import.

ProfileReport

Per-profile report.

PropertyName

Validation model property name.

PropertyPath

Dot-separated property path.

RawXmlReportWriter

Raw processor-style XML report writer.

RepairBatchReport

Batch metadata repair report.

RepairBatchSummary

Batch metadata repair summary counters.

RepairReport

Metadata repair report for one input.

ResourceLimits

Parser and validation resource limits.

Rule

Validation rule.

RuleId

Rule id.

SpecReference

Specification citation associated with a validation rule.

StreamObject

Parsed stream object with raw byte range metadata.

TaskDuration

Task duration entry.

TextReportWriter

Human-readable text report writer.

Trailer

Parsed trailer dictionary.

UnsupportedRule

Unsupported rule detail.

ValidationFlavour

Validation flavour identifier.

ValidationOptions

PDF validation options shared by parser, engine, and reports.

ValidationProfile

Immutable validation profile.

ValidationReport

Complete validation report for one input.

Validator

Validation facade for parser, profile selection, traversal, and reports.

XmlReportWriter

Machine-readable XML report writer.

XmpPacket

Parsed XMP packet summary.

XmpParser

Bounded XMP parser.

Enums

AssertionStatus

Assertion status.

BinaryOp

Binary expression operator.

BuiltinFunction

Bounded built-in function.

ConfigError

Configuration-specific error.

CosObject

PDF COS object.

ExitCategory

CLI-oriented exit category represented in batch summaries.

FeatureSelection

Feature extraction selection.

FeatureValue

Feature property value.

FlavourSelection

Flavour/profile selection policy.

InputKind

Input kind.

ModelObjectRef

Validation model object reference.

ModelValue

Model value used by rule evaluation.

ParseError

Parser-specific error.

ParseFact

Parser fact emitted by tolerant parsing.

PdfvError

Top-level library error.

PolicyError

Feature policy error.

PolicyOperator

Bounded policy comparison operator.

PolicyValue

Policy comparison value.

ProfileError

Profile-specific error.

RepairAction

Metadata repair action.

RepairError

Metadata repair error.

RepairRefusal

Explicit reason metadata repair was refused.

RepairStatus

Metadata repair status.

ReportError

Reporting-specific error.

ReportFormat

Report output format.

RuleExpr

Bounded rule expression.

RuleOutcome

Rule evaluation outcome.

SourceStorage

Parser-owned storage for source bytes.

StreamFact

Stream parser fact.

UnaryOp

Unary expression operator.

ValidationError

Validation-specific error.

ValidationStatus

Overall validation status.

ValidationWarning

Validation warning.

XmpFact

XMP metadata parser fact.

XmpIdentificationKind

Recognized XMP identification schema kind.

XrefFact

Cross-reference parser fact.

Constants

ENGINE_VERSION

Current library version embedded in generated reports.

Traits

ModelObject

Validation model object.

PdfSource

Seekable PDF source accepted by Parser.

ProfileRepository

Repository that resolves validation profiles for a caller selection.

ReportWriter

Report writer interface.

RuleEvaluator

Rule evaluator interface.

StreamDecoder

Stream decoder extension point used by DecoderRegistry.

Functions

display_flavour

Returns the stable CLI/catalog spelling for a validation flavour.

import_verapdf_profile_xml

Imports a veraPDF validation profile XML document into bounded profile data.

Type Aliases

Result

Result alias for pdfv library operations.