Struct Annotation 

pub struct Annotation {
    pub annotation_type: AnnotationType,
    pub rect: Rectangle,
    pub contents: Option<String>,
    pub subject: Option<String>,
    pub name: Option<String>,
    pub modified: Option<String>,
    pub flags: AnnotationFlags,
    pub border: Option<BorderStyle>,
    pub color: Option<Color>,
    pub page: Option<ObjectReference>,
    pub properties: Dictionary,
    /* private fields */
}

Base annotation structure

Fields

annotation_type: AnnotationType

Annotation type

rect: Rectangle

Rectangle defining annotation position

contents: Option<String>

Optional content text

subject: Option<String>

Optional subject

name: Option<String>

Optional annotation name

modified: Option<String>

Modification date

flags: AnnotationFlags

Flags

border: Option<BorderStyle>

Border style

color: Option<Color>

Color

page: Option<ObjectReference>

Page reference (set by manager)

properties: Dictionary

Additional properties specific to annotation type

Implementations

impl Annotation

pub fn new(annotation_type: AnnotationType, rect: Rectangle) -> Self

Create a new annotation

pub fn with_contents(self, contents: impl Into<String>) -> Self

Set contents

pub fn with_subject(self, subject: impl Into<String>) -> Self

Set subject

pub fn with_name(self, name: impl Into<String>) -> Self

Set name

pub fn with_color(self, color: Color) -> Self

Set color

pub fn with_border(self, border: BorderStyle) -> Self

Set border

pub fn with_flags(self, flags: AnnotationFlags) -> Self

Set flags

pub fn set_field_dict(&mut self, field_dict: Dictionary)

Set field dictionary properties (for widget annotations)

pub fn set_field_parent(&mut self, parent: ObjectReference)

Set the parent form-field reference for a Widget annotation.

Widget annotations that live as children of an /AcroForm field (ISO 32000-1 §12.7.3.1) must carry /Parent pointing at the parent field dictionary. This setter records that relationship; the writer remaps the placeholder to a real indirect-object id at serialization time.

Only meaningful for AnnotationType::Widget.

Panics

In debug builds, calling this on a non-Widget annotation trips a debug_assert! — using /Parent on a non-Widget annotation is a spec violation and almost always a programmer error. In release builds the setter still stores the value (no panic), but the defence-in-depth check in to_dict will refuse to emit /Parent for non-Widget annotations, so a mis-targeted call is degraded to a silent no-op rather than an invalid PDF.

pub fn to_dict(&self) -> Dictionary

Convert to PDF dictionary

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.