PdfElixide.Compliance.Report (pdf_elixide v0.23.0)

Copy Markdown View Source

The result of PdfElixide.Compliance.validate/2.

  • :standard — the standard the document was checked against, as requested.
  • :compliant? — true when the checks found no errors. Warnings do not affect it. See What a report establishes.
  • :declared — the PDF/A or PDF/X level the document identifies itself as in its own metadata, or nil when it declares none. It is read whichever level was requested, so a document validated against :pdf_a_2b may declare :pdf_a_1b. Always nil for PDF/UA.
  • :errors — the requirements the document fails, as PdfElixide.Compliance.Issue structs.
  • :warnings — findings that do not fail the standard, including notes on checks that were only partly performed.

Summary

Types

t()

@type t() :: %PdfElixide.Compliance.Report{
  compliant?: boolean(),
  declared: PdfElixide.Compliance.standard() | nil,
  errors: [PdfElixide.Compliance.Issue.t()],
  standard: PdfElixide.Compliance.standard(),
  warnings: [PdfElixide.Compliance.Issue.t()]
}