Skip to main content

AnnotationSubtype

pdf_oxide::annotation_types

Enum AnnotationSubtype 

Source 
pub enum AnnotationSubtype {

Show 28 variants    Text,
    Link,
    FreeText,
    Line,
    Square,
    Circle,
    Polygon,
    PolyLine,
    Highlight,
    Underline,
    Squiggly,
    StrikeOut,
    Stamp,
    Caret,
    Ink,
    Popup,
    FileAttachment,
    Sound,
    Movie,
    Widget,
    Screen,
    PrinterMark,
    TrapNet,
    Watermark,
    ThreeD,
    Redact,
    RichMedia,
    Unknown,

}
Expand description

Annotation subtype per PDF spec Table 169.

Variants§

§

Text

Text annotation (sticky note) - Section 12.5.6.4

Link annotation - Section 12.5.6.5

§

FreeText

Free text annotation - Section 12.5.6.6

§

Line

Line annotation - Section 12.5.6.7

§

Square

Square annotation - Section 12.5.6.8

§

Circle

Circle annotation - Section 12.5.6.8

§

Polygon

Polygon annotation - Section 12.5.6.9

§

PolyLine

Polyline annotation - Section 12.5.6.9

§

Highlight

Highlight annotation - Section 12.5.6.10

§

Underline

Underline annotation - Section 12.5.6.10

§

Squiggly

Squiggly underline annotation - Section 12.5.6.10

§

StrikeOut

Strikeout annotation - Section 12.5.6.10

§

Stamp

Rubber stamp annotation - Section 12.5.6.12

§

Caret

Caret annotation - Section 12.5.6.11

§

Ink

Ink annotation - Section 12.5.6.13

§

Popup

Popup annotation - Section 12.5.6.14

§

FileAttachment

File attachment annotation - Section 12.5.6.15

§

Sound

Sound annotation - Section 12.5.6.16

§

Movie

Movie annotation - Section 12.5.6.17

§

Widget

Widget annotation (form field) - Section 12.5.6.19

§

Screen

Screen annotation - Section 12.5.6.18

§

PrinterMark

Printer’s mark annotation - Section 12.5.6.20

§

TrapNet

Trap network annotation - Section 12.5.6.21

§

Watermark

Watermark annotation - Section 12.5.6.22

§

ThreeD

3D annotation - Section 12.5.6.24

§

Redact

Redaction annotation - Section 12.5.6.23

§

RichMedia

RichMedia annotation - Adobe Extension Level 3

§

Unknown

Unknown annotation type

Implementations§

Source§

impl AnnotationSubtype

Source

pub fn pdf_name(&self) -> &'static str

Get the PDF name for this annotation subtype.

Source

pub fn from_pdf_name(name: &str) -> Self

Parse from PDF name.

Source

pub fn is_markup(&self) -> bool

Check if this is a markup annotation (has popup, replies, etc.)

Source

pub fn is_text_markup(&self) -> bool

Check if this is a text markup annotation.

Trait Implementations§

Source§

impl Clone for AnnotationSubtype

Source§

fn clone(&self) -> AnnotationSubtype

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnnotationSubtype

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for AnnotationSubtype

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for AnnotationSubtype

Source§

fn eq(&self, other: &AnnotationSubtype) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for AnnotationSubtype

Source§

impl Eq for AnnotationSubtype

Source§

impl StructuralPartialEq for AnnotationSubtype

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<T> Ungil for T
where T: Send,