Enum pdfium_render::page_annotation::PdfPageAnnotation

source · [−]

pub enum PdfPageAnnotation<'a> {
Show 13 variants
    Circle(PdfPageCircleAnnotation<'a>),
    FreeText(PdfPageFreeTextAnnotation<'a>),
    Highlight(PdfPageHighlightAnnotation<'a>),
    Ink(PdfPageInkAnnotation<'a>),
    Link(PdfPageLinkAnnotation<'a>),
    Popup(PdfPagePopupAnnotation<'a>),
    Square(PdfPageSquareAnnotation<'a>),
    Squiggly(PdfPageSquigglyAnnotation<'a>),
    Stamp(PdfPageStampAnnotation<'a>),
    Strikeout(PdfPageStrikeoutAnnotation<'a>),
    Text(PdfPageTextAnnotation<'a>),
    Underline(PdfPageUnderlineAnnotation<'a>),
    Unsupported(PdfPageUnsupportedAnnotation<'a>),
}

Expand description

A single user annotation on a PdfPage.

Variants

`Circle(PdfPageCircleAnnotation<'a>)`

`FreeText(PdfPageFreeTextAnnotation<'a>)`

`Highlight(PdfPageHighlightAnnotation<'a>)`

`Ink(PdfPageInkAnnotation<'a>)`

`Link(PdfPageLinkAnnotation<'a>)`

`Popup(PdfPagePopupAnnotation<'a>)`

`Square(PdfPageSquareAnnotation<'a>)`

`Squiggly(PdfPageSquigglyAnnotation<'a>)`

`Stamp(PdfPageStampAnnotation<'a>)`

`Strikeout(PdfPageStrikeoutAnnotation<'a>)`

`Text(PdfPageTextAnnotation<'a>)`

`Underline(PdfPageUnderlineAnnotation<'a>)`

`Unsupported(PdfPageUnsupportedAnnotation<'a>)`

Common properties shared by all PdfPageAnnotation types can still be accessed for annotations not supported by Pdfium, but annotation-specific functionality will be unavailable.

Implementations

impl<'a> PdfPageAnnotation<'a>

pub fn annotation_type(&self) -> PdfPageAnnotationType

The type of this PdfPageAnnotation.

Not all PDF annotation types are supported by Pdfium. For example, Pdfium does not currently support embedded sound or movie files, embedded 3D animations, or embedded file attachments generally.

Pdfium currently supports creating, editing, and rendering the following types of annotations:

pub fn is_supported(&self) -> bool

Returns true if Pdfium supports creating, editing, and rendering this type of PdfPageAnnotation.

Not all PDF annotation types are supported by Pdfium. For example, Pdfium does not currently support embedded sound or movie files, embedded 3D animations, or embedded file attachments generally.

Pdfium currently supports creating, editing, and rendering the following types of annotations:

pub fn is_unsupported(&self) -> bool

Returns true if Pdfium does not support creating, editing, and rendering this type of PdfPageAnnotation.

Not all PDF annotation types are supported by Pdfium. For example, Pdfium does not currently support embedded sound or movie files, embedded 3D animations, or embedded file attachments generally.

Pdfium currently supports creating, editing, and rendering the following types of annotations:

pub fn as_circle_annotation(&self) -> Option<&PdfPageCircleAnnotation<'_>>

Returns the underlying PdfPageCircleAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Circle.

pub fn as_free_text_annotation(&self) -> Option<&PdfPageFreeTextAnnotation<'_>>

Returns the underlying PdfPageFreeTextAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::FreeText.

pub fn as_highlight_annotation(&self) -> Option<&PdfPageHighlightAnnotation<'_>>

Returns the underlying PdfPageHighlightAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Highlight.

pub fn as_ink_annotation(&self) -> Option<&PdfPageInkAnnotation<'_>>

Returns the underlying PdfPageInkAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Ink.

pub fn as_link_annotation(&self) -> Option<&PdfPageLinkAnnotation<'_>>

Returns the underlying PdfPageLinkAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Link.

pub fn as_popup_annotation(&self) -> Option<&PdfPagePopupAnnotation<'_>>

Returns the underlying PdfPagePopupAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Popup.

pub fn as_square_annotation(&self) -> Option<&PdfPageSquareAnnotation<'_>>

Returns the underlying PdfPageSquareAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Square.

pub fn as_squiggly_annotation(&self) -> Option<&PdfPageSquigglyAnnotation<'_>>

Returns the underlying PdfPageSquigglyAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Squiggly.

pub fn as_stamp_annotation(&self) -> Option<&PdfPageStampAnnotation<'_>>

Returns the underlying PdfPageStampAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Stamp.

pub fn as_strikeout_annotation(&self) -> Option<&PdfPageStrikeoutAnnotation<'_>>

Returns the underlying PdfPageStrikeoutAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Strikeout.

pub fn as_text_annotation(&self) -> Option<&PdfPageTextAnnotation<'_>>

Returns the underlying PdfPageTextAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Text.

pub fn as_underline_annotation(&self) -> Option<&PdfPageUnderlineAnnotation<'_>>

Returns the underlying PdfPageUnderlineAnnotation for this PdfPageAnnotation, if this annotation has an annotation type of PdfPageAnnotationType::Underline.

Trait Implementations

impl<'a> Drop for PdfPageAnnotation<'a>

fn drop(&mut self)

Closes this PdfPageAnnotation, releasing held memory.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for PdfPageAnnotation<'a>

impl<'a> !Send for PdfPageAnnotation<'a>

impl<'a> !Sync for PdfPageAnnotation<'a>

impl<'a> Unpin for PdfPageAnnotation<'a>

impl<'a> !UnwindSafe for PdfPageAnnotation<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> PdfPageAnnotationCommon for T where
T: PdfPageAnnotationPrivate,

fn bounds(&self) -> Result<PdfRect, PdfiumError>

Returns the bounding box of this PdfPageAnnotation.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.