Struct Annotation 

pub struct Annotation<'a> { /* private fields */ }

A PDF annotation, wrapping the raw dictionary.

Implementations

impl<'a> Annotation<'a>

pub fn from_page(page: &Page<'a>) -> Vec<Self>

Parse all annotations from a page.

pub fn from_dict(dict: Dict<'a>) -> Self

Wrap an existing annotation dictionary.

pub fn dict(&self) -> &Dict<'a>

Return the raw annotation dictionary.

pub fn annotation_type(&self) -> AnnotationType

Return the annotation subtype.

pub fn rect(&self) -> Option<Rect>

Return the annotation rectangle.

pub fn contents(&self) -> Option<String>

Return the text contents of the annotation.

pub fn flags(&self) -> AnnotationFlags

Return the annotation flags.

pub fn is_hidden(&self) -> bool

Whether the annotation is hidden.

pub fn is_printable(&self) -> bool

Whether the annotation should be printed.

pub fn name(&self) -> Option<String>

Return the unique annotation name (/NM).

pub fn modified(&self) -> Option<String>

Return the modification date (/M).

pub fn author(&self) -> Option<String>

Return the author (/T).

pub fn subject(&self) -> Option<String>

Return the subject (/Subj).

pub fn color(&self) -> Option<Color>

Return the annotation color (/C).

pub fn border_style(&self) -> Option<BorderStyle>

Return the border style (/BS).

pub fn border_array(&self) -> Option<[f32; 3]>

Return the legacy border array (/Border).

pub fn border_effect(&self) -> Option<BorderEffect>

Return the border effect (/BE).

pub fn interior_color(&self) -> Option<Color>

Return the interior color (/IC).

pub fn appearance(&self) -> Option<AppearanceDict<'a>>

Return the appearance dictionary (/AP).

pub fn normal_appearance(&self) -> Option<Stream<'a>>

Return the normal appearance stream directly.

pub fn creation_date(&self) -> Option<String>

Return the creation date (/CreationDate).

pub fn opacity(&self) -> Option<f32>

Return the opacity (/CA).

pub fn irt(&self) -> Option<Annotation<'a>>

Return the in-reply-to annotation dictionary (/IRT).

pub fn reply_type(&self) -> Option<String>

Return the reply type (/RT).

pub fn state(&self) -> Option<String>

Return the annotation state (/State).

pub fn state_model(&self) -> Option<String>

Return the state model (/StateModel).

pub fn popup(&self) -> Option<Annotation<'a>>

Return the popup annotation dictionary (/Popup).

pub fn quad_points(&self) -> Option<QuadPoints>

Return quad points (/QuadPoints).

Trait Implementations

impl<'a> Clone for Annotation<'a>

fn clone(&self) -> Annotation<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Annotation<'a>

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

Formats the value using the given formatter.