Skip to main content

AnnotSubtype

pdf_annot::builder::types

Enum AnnotSubtype 

Source 
pub enum AnnotSubtype {

Show 14 variants    Square,
    Circle,
    Line,
    Highlight,
    Underline,
    StrikeOut,
    Squiggly,
    FreeText,
    Text,
    Stamp,
    Ink,
    Polygon,
    PolyLine,
    Link,

}
Expand description

PDF annotation subtype as defined by ISO 32000-2 §12.5.6.

Each variant maps directly to the /Subtype name written into the annotation dictionary. Use the typed constructors on super::AnnotationBuilder (square, highlight, link_uri, …) instead of constructing this enum directly when possible — they wire up the per-subtype defaults that are required for a valid annotation.

Variants§

§

Square

Filled or stroked rectangle (/Square). Used for emphasis or region marking. Pair with super::AnnotationBuilder::interior_color for a fill.

§

Circle

Filled or stroked ellipse (/Circle) inscribed in the rectangle. Pair with super::AnnotationBuilder::interior_color for a fill.

§

Line

Line segment (/Line) between two points, optionally with arrow or other end caps. See super::AnnotationBuilder::line and super::AnnotationBuilder::line_endings.

§

Highlight

Text-markup highlight (/Highlight) — semi-transparent yellow fill over a text range. Use super::AnnotationBuilder::quad_points to mark the actual text quadrilaterals.

§

Underline

Text-markup underline (/Underline) drawn beneath a text range.

§

StrikeOut

Text-markup strike-through (/StrikeOut) drawn through a text range.

§

Squiggly

Text-markup squiggly underline (/Squiggly) — typically used to flag spelling or grammar concerns.

§

FreeText

Free-text annotation (/FreeText) — text rendered directly on the page (vs. a popup note). See super::AnnotationBuilder::free_text.

§

Text

Sticky-note annotation (/Text). Despite the name, this is the “popup comment” style — a small icon on the page that opens a text bubble in the viewer. See super::AnnotationBuilder::sticky_note.

§

Stamp

Rubber stamp annotation (/Stamp) — APPROVED, DRAFT, CONFIDENTIAL, etc. See crate::StampName for the standard set and super::AnnotationBuilder::stamp / super::AnnotationBuilder::stamp_custom.

§

Ink

Free-hand ink annotation (/Ink) consisting of one or more stroke paths. See super::AnnotationBuilder::ink.

§

Polygon

Closed polygon (/Polygon) defined by a list of vertices. Optionally filled with super::AnnotationBuilder::interior_color.

§

PolyLine

Open polyline (/PolyLine) defined by a list of vertices. Stroked but not filled.

Hyperlink annotation (/Link) — invisible by default, the viewer renders it as a clickable region. See super::AnnotationBuilder::link_uri and super::AnnotationBuilder::link_dest.

Trait Implementations§

Source§

impl Clone for AnnotSubtype

Source§

fn clone(&self) -> AnnotSubtype

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 AnnotSubtype

Source§

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

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

impl Copy for AnnotSubtype

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<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, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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