Module names

Expand description

The dictionary-key names the specification defines, as constants.

One declaration site for the whole workspace: a key spelled here is never spelled again at a use site, so a typo cannot silently produce a lookup that never matches. Grouped the way ISO 32000-1 groups them; crates add their keys to the group they belong to as they land.

use pdfrum_object::{Dict, Object, names};

let dict = Dict::from_pairs([(names::TYPE.clone(), Object::Name(names::PAGE.clone()))]);
assert_eq!(dict.raw(names::TYPE), Some(&Object::Name(names::PAGE.clone())));

Constants§

A85: Inline-image abbreviation for /ASCII85Decode (/A85).
AA: Additional-actions dictionary (/AA).
ACRO_FORM: The interactive form dictionary (/AcroForm).
AHX: Inline-image abbreviation for /ASCIIHexDecode (/AHx).
AIS: Whether alpha is a shape or an opacity (/AIS).
ALPHA: An alpha soft mask (/Alpha).
ANNOTS: A page’s annotation array (/Annots).
AP: The appearance dictionary (/AP).
ART_BOX: The extent of the page’s meaningful content (/ArtBox).
AS: The appearance state selecting a sub-appearance (/AS).
ASCENT: Maximum height above the baseline (/Ascent).
ASCII85_DECODE: Base-85 text encoding (/ASCII85Decode).
ASCII_HEX_DECODE: Hexadecimal text encoding (/ASCIIHexDecode).
AUTHOR: Who wrote the document (/Author).
AUTH_EVENT: When a crypt filter’s key is requested (/AuthEvent).
BASE_ENCODING: The encoding a /Differences array modifies (/BaseEncoding).
BASE_FONT: The PostScript name of a font (/BaseFont).
BBOX: A form’s or pattern’s clipping rectangle (/BBox).
BC: Border colour (/BC), also a soft mask’s backdrop.
BG: Background colour (/BG), also a widget’s background.
BITS_PER_COMPONENT: Bits per colour component (/BitsPerComponent).
BLACK_IS_1: Whether a CCITT 1 bit means black (/BlackIs1).
BLEED_BOX: The region clipped to when producing output (/BleedBox).
BM: Blend mode (/BM).
BORDER: Border characteristics (/Border).
C: Colour (/C).
CA: Normal caption (/CA), also the non-stroking alpha constant.
CAP_HEIGHT: Height of a capital letter (/CapHeight).
CA_LOWER: Non-stroking alpha (/ca); stroking alpha is /CA.
CCF: Inline-image abbreviation for /CCITTFaxDecode (/CCF).
CCITT_FAX_DECODE: Group 3/4 fax compression (/CCITTFaxDecode).
CF: The crypt filter dictionary (/CF).
CFM: A crypt filter’s method (/CFM).
CID_SYSTEM_INFO: The CID collection this font is keyed to (/CIDSystemInfo).
CID_TO_GID_MAP: Maps a CID to a glyph index (/CIDToGIDMap).
COLLECTION: A portable collection, i.e. a portfolio (/Collection).
COLOR: The Color blend mode.
COLORS: Colour components per sample, for a predictor (/Colors).
COLOR_BURN: The ColorBurn blend mode.
COLOR_DODGE: The ColorDodge blend mode.
COLOR_SPACE: An image’s or shading’s colour space (/ColorSpace).
COLUMNS: Samples per row (/Columns).
CONTENTS: The annotation’s text, or a page’s content stream (/Contents).
COUNT: Number of leaf pages below a page-tree node (/Count).
CREATION_DATE: When the document was created (/CreationDate).
CREATOR: The application that produced the original document (/Creator).
CROP_BOX: The region of a page a viewer displays (/CropBox). Inheritable.
CRYPT: The crypt filter placeholder (/Crypt).
CS: A group’s colour space (/CS).
D: A destination, an appearance’s down state, and a dash pattern (/D).
DA: Default appearance string (/DA).
DARKEN: The Darken blend mode.
DCT: Inline-image abbreviation for /DCTDecode (/DCT).
DCT_DECODE: Baseline JPEG (/DCTDecode).
DECODE: Sample-value remapping (/Decode).
DECODE_PARMS: Parameters for the filters (/DecodeParms).
DESCENDANT_FONTS: The descendant CIDFont of a Type 0 font (/DescendantFonts).
DESCENT: Maximum depth below the baseline (/Descent).
DESTS: The named-destination dictionary (/Dests).
DIFFERENCE: The Difference blend mode.
DIFFERENCES: Per-code overrides on the base encoding (/Differences).
DS: Default style string (/DS).
DV: Default value (/DV).
E: Offset of the end of the first page (/E).
EARLY_CHANGE: Whether LZW code lengths grow one code early (/EarlyChange).
EFF: Crypt filter used for embedded files (/EFF).
EMBEDDED_FILE: The /Type of an embedded file stream (/EmbeddedFile).
EMBEDDED_FILES: The embedded-file name tree (/EmbeddedFiles).
ENCODED_BYTE_ALIGN: Whether each CCITT row starts on a byte boundary (/EncodedByteAlign).
ENCODING: A simple font’s encoding or a Type0 font’s CMap (/Encoding).
ENCRYPT: The encryption dictionary (/Encrypt).
ENCRYPT_METADATA: Whether the document metadata is encrypted (/EncryptMetadata).
END_OF_LINE: Whether CCITT rows are terminated by end-of-line codes (/EndOfLine).
EXCLUSION: The Exclusion blend mode.
EXT_G_STATE: The graphics-state parameter resource category (/ExtGState).
F: External file holding the data, also an annotation’s flag word (/F — the meaning follows the dictionary, not the key).
FF: Field flags (/Ff).
FILTER: Filter or filter chain applied to the stream data (/Filter).
FIRST: Offset of the first object in an object stream (/First).
FIRST_CHAR: First code a simple font’s /Widths covers (/FirstChar).
FL: Inline-image abbreviation for /FlateDecode (/Fl).
FLAGS: Descriptor flags, and a form-action flag word (/Flags).
FLATE_DECODE: Deflate compression (/FlateDecode).
FONT: The font resource category, and a font dictionary’s own /Type value (/Font).
FONT_BBOX: Glyph extents (/FontBBox).
FONT_DESCRIPTOR: A font’s metrics and embedded program (/FontDescriptor).
FONT_FILE: An embedded Type 1 program (/FontFile).
FONT_FILE2: An embedded TrueType program (/FontFile2).
FONT_FILE3: An embedded program in some other format, CFF included (/FontFile3).
FORM: A form external object’s /Subtype value (/Form).
FORM_TYPE: A form XObject’s generation number, always 1 (/FormType).
FT: The field type (/FT).
G: The form XObject a soft mask draws (/G).
H: Offset and length of the hint stream (/H).
HARD_LIGHT: The HardLight blend mode.
HEIGHT: Image height in samples (/Height).
HUE: The Hue blend mode.
I: Normal icon (/I), also a transparency group’s isolation flag.
IC: An annotation’s interior colour (/IC).
ID: The file identifier pair (/ID).
IDENTITY: The pass-through crypt filter (/Identity).
IMAGE: An image external object’s /Subtype value (/Image).
IMAGE_MASK: Whether the image is a stencil mask (/ImageMask).
INDEX: Subsection object-number ranges of a cross-reference stream (/Index).
INFO: The document information dictionary (/Info).
INK_LIST: Ink annotation stroke list (/InkList).
IT: The intent of a markup or screen annotation (/IT).
ITALIC_ANGLE: Degrees clockwise from vertical (/ItalicAngle).
IX: Alternate (down) icon (/IX).
JAVA_SCRIPT: The document-level JavaScript name tree (/JavaScript).
JBIG2_DECODE: Bi-level JBIG2 compression (/JBIG2Decode).
JPX_DECODE: JPEG 2000 (/JPXDecode).
K: The CCITT encoding scheme selector (/K).
KEYWORDS: Keywords associated with the document (/Keywords).
KIDS: Children of a page-tree node (/Kids).
L: Length of the whole file (/L), also a line annotation’s endpoints.
LAST_CHAR: Last code a simple font’s /Widths covers (/LastChar).
LENGTH: Number of bytes of stream data (/Length).
LIGHTEN: The Lighten blend mode.
LUMINOSITY: The Luminosity blend mode.
LZW: Inline-image abbreviation for /LZWDecode (/LZW).
LZW_DECODE: LZW compression (/LZWDecode).
M: Last-modified date (/M).
MAC_EXPERT_ENCODING: The expert-set encoding (/MacExpertEncoding).
MAC_ROMAN_ENCODING: The Mac OS standard encoding (/MacRomanEncoding).
MATRIX: A form’s, pattern’s or shading’s coordinate mapping (/Matrix).
MEDIA_BOX: The sheet a page is imaged on (/MediaBox). Inheritable.
METADATA: Metadata stream (/Metadata).
MOD_DATE: When the document was last modified (/ModDate).
MULTIPLY: The Multiply blend mode.
N: Number of objects in an object stream (/N).
NAMES: The name dictionary (/Names).
NM: The annotation’s name, unique within the page (/NM).
NORMAL: The Normal blend mode.
O: Owner password hash (/O), also a linearized file’s first page object number.
OBJ_STM: An object stream (/ObjStm).
OC: Optional-content membership (/OC).
OE: Owner encryption key, revision 5 and 6 (/OE).
ORDERING: Ordering name inside /CIDSystemInfo (/Ordering).
OUTLINES: The outline (bookmark) tree root (/Outlines).
OVERLAY: The Overlay blend mode.
P: Permission flags (/P), also an annotation’s page reference and a linearized file’s first-page offset.
PAGE: A leaf of the page tree (/Page).
PAGES: The root of the page tree (/Pages).
PAGE_LABELS: The page label number tree (/PageLabels).
PARENT: The parent node of a page-tree node or form field (/Parent).
PDF_DOC_ENCODING: The document-string encoding (/PDFDocEncoding).
PERMS: Encrypted permissions, revision 5 and 6 (/Perms).
PREDICTOR: Which predictor was applied before compression (/Predictor).
PREV: Offset of the previous cross-reference section (/Prev).
PRODUCER: The application that converted it to PDF (/Producer).
PROPERTIES: The marked-content property resource category (/Properties).
Q: Quadding — the text alignment code (/Q).
QUAD_POINTS: A text-markup annotation’s quadrilaterals (/QuadPoints).
R: Standard security handler revision (/R), also an appearance’s rollover state.
RECT: The annotation’s rectangle (/Rect).
RESOURCES: The resources a page or form needs (/Resources). Inheritable through the page tree.
RI: Rollover icon (/RI).
RL: Inline-image abbreviation for /RunLengthDecode (/RL).
ROOT: The document catalog (/Root).
ROTATE: Clockwise display rotation in degrees (/Rotate). Inheritable.
ROWS: Number of rows in a CCITT image (/Rows).
RUN_LENGTH_DECODE: Byte-oriented run-length compression (/RunLengthDecode).
S: A soft mask’s or transparency group’s subtype (/S).
SATURATION: The Saturation blend mode.
SCREEN: The Screen blend mode.
SHADING: The shading resource category (/Shading), which the sh operator names its shading in.
SIG: Signature field type (/Sig).
SIZE: One past the highest object number (/Size).
SMASK: A soft mask, either an image’s or an /ExtGState’s (/SMask).
SOFT_LIGHT: The SoftLight blend mode.
STANDARD: The standard security handler (/Standard).
STEM_V: Vertical stem thickness (/StemV).
STM_F: Crypt filter used for streams (/StmF).
STR_F: Crypt filter used for strings (/StrF).
SUBJECT: What the document is about (/Subject).
SUBTYPE: A more specific type within a /Type (/Subtype).
T: Offset of the main cross-reference table (/T), also a form field’s partial name.
TITLE: The document’s title (/Title).
TO_UNICODE: The character-code-to-Unicode CMap (/ToUnicode).
TR: A soft mask’s transfer function (/TR).
TRIM_BOX: The intended finished dimensions after trimming (/TrimBox).
TRUE_TYPE: A TrueType font’s /Subtype value (/TrueType).
TU: Alternate field name, shown to the user (/TU).
TYPE: What kind of dictionary this is (/Type).
TYPE1: A Type 1 font’s /Subtype value (/Type1).
U: User password hash (/U).
UE: User encryption key, revision 5 and 6 (/UE).
V: Algorithm version, also a form field’s value (/V).
VIEWER_PREFERENCES: Viewer preferences (/ViewerPreferences).
W: Field widths of a cross-reference stream’s entries (/W).
WIDTH: Image width in samples (/Width).
WIDTHS: Per-code advance widths of a simple font (/Widths).
WIN_ANSI_ENCODING: The Windows code page 1252 encoding (/WinAnsiEncoding).
XFA: The XFA form packet, whose presence makes a form an XFA one (/XFA).
XML: An XML metadata stream’s subtype (/XML).
XOBJECT: The external-object resource category — images and forms alike — and an external object’s own /Type value (/XObject).
XREF: A cross-reference stream (/XRef).
XREF_STM: Offset of a hybrid file’s cross-reference stream (/XRefStm).

Module names

Module names Copy item path

Constants§

Module names