Skip to main content

PdfAnnotation

Struct PdfAnnotation 

Source
pub struct PdfAnnotation {
    pub source_page_index: usize,
    pub rect: [f32; 4],
    pub contents: Option<String>,
    pub name: Option<String>,
    pub modified: Option<String>,
    pub flags: u32,
    pub colour: Option<Vec<f32>>,
    pub border: Option<Vec<f32>>,
    pub appearance: Option<AnnotationAppearance>,
    pub appearance_state: Option<String>,
    pub kind: AnnotationKind,
}
Expand description

One annotation entry surfaced by annotations.

The fields are the cross-subtype intersection; per-subtype detail hangs off Self::kind.

Fields§

§source_page_index: usize

0-based page index — which page in DFS order carries this annotation in its /Annots array.

§rect: [f32; 4]

/Rect — annotation rectangle in default user space (PDF coordinates, origin bottom-left).

§contents: Option<String>

/Contents — text content (description / title for sticky notes, raw text for FreeText).

§name: Option<String>

/NM — annotation name (UID per Table 164). Optional; many authoring tools omit it.

§modified: Option<String>

/M — last-modified date (raw PDF date string, no parse).

§flags: u32

/F — annotation flag word (Table 167). Bit 0 = Invisible, bit 1 = Hidden, bit 2 = Print, bit 3 = NoZoom, bit 4 = NoRotate, bit 5 = NoView, bit 6 = ReadOnly, bit 7 = Locked, bit 8 = ToggleNoView, bit 9 = LockedContents.

§colour: Option<Vec<f32>>

/C — colour: 0/1/3/4 numbers (Transparent / Gray / RGB / CMYK).

§border: Option<Vec<f32>>

/Border[hr vr w] or [hr vr w dash]. Most PDFs ship the 3-element variant; round-26 surfaces it untouched.

§appearance: Option<AnnotationAppearance>

/AP — §12.5.5 appearance-dictionary summary (Table 168). None when the annotation carries no appearance dictionary.

§appearance_state: Option<String>

/AS — the appearance state selecting the applicable stream from an appearance subdictionary (required by Table 164 when /AP contains one or more subdictionaries).

§kind: AnnotationKind

Per-subtype payload.

Trait Implementations§

Source§

impl Clone for PdfAnnotation

Source§

fn clone(&self) -> PdfAnnotation

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 PdfAnnotation

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = Infallible

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V