PdfElixide.Form.Field.Unknown (pdf_elixide v0.15.0)

Copy Markdown View Source

A field with no recognized /FT — either a grouping parent that declares no type at all, or a field whose /FT names a type that is not understood.

The only kind carrying a :raw_type, which tells the two apart, and the only one with no :kind — there is no type whose bits would say what it is. :flags is therefore PdfElixide.Form.Field.Flags, holding only the three bits every field has.

:value is whatever the field's /V holds, or nil; a grouping parent has none. See PdfElixide.Form.Field.value/0.

Summary

Types

The /FT name as written when one exists but is unrecognized (e.g. "Barcode"); nil when the field declares no /FT at all.

t()

Types

raw_type()

@type raw_type() :: String.t() | nil

The /FT name as written when one exists but is unrecognized (e.g. "Barcode"); nil when the field declares no /FT at all.

%PdfElixide.Form.Field.Unknown{raw_type: nil, value: nil} is the observable signature of a grouping parent — the field named "person" in a form whose leaves are "person.first" and "person.last".

t()

@type t() :: %PdfElixide.Form.Field.Unknown{
  flags: PdfElixide.Form.Field.Flags.t(),
  name: String.t(),
  raw_type: raw_type(),
  value: PdfElixide.Form.Field.value()
}