Skip to main content

StructuralRecord

Enum StructuralRecord 

Source
#[non_exhaustive]
pub enum StructuralRecord { DocInfo(DocInfoRecord), Outline(OutlineRecord), Annotation(AnnotationRecord), Dest(DestRecord), PageOverride(PageOverrideRecord), ViewerPrefs(ViewerPrefsRecord), Metadata(MetadataRecord), Form(FormRecord), Embed(EmbedRecord), OutputIntent(OutputIntentRecord), }
Expand description

One accumulated structural record. Each variant corresponds to a PDF catalog / info / page entry the writer knows how to emit.

Marked #[non_exhaustive]: cross-crate match sites need a wildcard arm so future record types (Tagged PDF, etc.) land additively.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

DocInfo(DocInfoRecord)

/DOCINFO — entries to merge into the PDF Info dictionary.

§

Outline(OutlineRecord)

/OUT — one bookmark entry, contributing to the document’s outline tree.

§

Annotation(AnnotationRecord)

/ANN — one page annotation (link, sticky note, free-text, …).

§

Dest(DestRecord)

/DEST — one named destination contributing to /Names /Dests.

§

PageOverride(PageOverrideRecord)

/PAGE (single-page override) or /PAGES (document-wide default for keys that aren’t already overridden on a specific page).

§

ViewerPrefs(ViewerPrefsRecord)

/VIEWERPREFERENCES — catalog-level viewer preferences plus the /PageLayout and /PageMode overrides that live directly on /Catalog rather than nested under /ViewerPreferences.

§

Metadata(MetadataRecord)

/Metadata — XMP metadata stream attached to /Catalog.

§

Form(FormRecord)

/FORM — document-level AcroForm dict. Multiple records merge last-wins key-by-key; the /Fields array is implicit (built from /Widget annotations at write time).

§

Embed(EmbedRecord)

/EMBED — one embedded file attachment. Multiple records accumulate; the writer assembles a /Names /EmbeddedFiles name tree and references it from /Catalog.

§

OutputIntent(OutputIntentRecord)

/OUTPUTINTENT — one /Catalog /OutputIntents entry naming the destination color rendering condition for this PDF (PDF/X / PDF/A). The writer emits one PDF object per record plus an array referencing them all from /Catalog /OutputIntents. Multiple records produce multiple intents — the array’s order matches the record order, and consumers traditionally honor the first matching subtype.

Trait Implementations§

Source§

impl Clone for StructuralRecord

Source§

fn clone(&self) -> StructuralRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StructuralRecord

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.