Skip to main content

AnnotationRecord

Struct AnnotationRecord 

Source
pub struct AnnotationRecord {
    pub page: u32,
    pub rect: [f64; 4],
    pub color: Option<[f64; 3]>,
    pub border: Option<Border>,
    pub title: Option<String>,
    pub contents: Option<String>,
    pub subtype: AnnotationSubtype,
}
Expand description

One /ANN entry. Each record contributes a single annotation (/Annot) to one page’s /Annots array. page is 1-based; 0 is reserved for “no explicit page” (the writer substitutes the page being assembled at the time the record fired).

Fields§

§page: u32

Page the annotation lives on (1-based). Set by the operator: an explicit /Page (or /SrcPg alias) wins; otherwise the writer falls back to current_page + 1 from DocumentStructure::current_page.

§rect: [f64; 4]

/Rect [llx lly urx ury] — default user-space bounds. Required per PDF spec; defaulted to the empty rect on malformed input so the annotation at least has somewhere to land.

§color: Option<[f64; 3]>

Optional /Color triple in [0, 1] (PDF /C entry).

§border: Option<Border>

Optional border specification. Translates to /Border on output.

§title: Option<String>

Optional /Title (annotator name) — meaningful for /Text and /FreeText.

§contents: Option<String>

Optional /Contents — meaningful for /Text and /FreeText; also accepted as a tooltip on /Link.

§subtype: AnnotationSubtype

Subtype-specific payload.

Trait Implementations§

Source§

impl Clone for AnnotationRecord

Source§

fn clone(&self) -> AnnotationRecord

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 AnnotationRecord

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.