Skip to main content

Destination

pdf_annot

Enum Destination 

Source 
pub enum Destination {
    Xyz {
        page_index: Option<u32>,
        left: Option<f32>,
        top: Option<f32>,
        zoom: Option<f32>,
    },
    Fit {
        page_index: Option<u32>,
    },
    FitH {
        page_index: Option<u32>,
        top: Option<f32>,
    },
    FitV {
        page_index: Option<u32>,
        left: Option<f32>,
    },
    FitR {
        page_index: Option<u32>,
        left: f32,
        bottom: f32,
        right: f32,
        top: f32,
    },
    FitB {
        page_index: Option<u32>,
    },
    FitBH {
        page_index: Option<u32>,
        top: Option<f32>,
    },
    FitBV {
        page_index: Option<u32>,
        left: Option<f32>,
    },
    Named(String),
}
Expand description

A PDF destination (ISO 32000-2 §12.3.2) — a target location and viewport recipe used by GoTo / GoToR actions and by direct /Dest link entries.

page_index is 0-based and may be None when the source PDF stored the destination as an indirect-reference array the parser could not resolve back to a page index. The remaining fields encode the “where on the page and at what zoom” portion of the destination.

Variants§

§

Xyz

/XYZ left top zoom — go to a specific position with optional zoom factor. None for any field means “preserve current viewer setting”.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§left: Option<f32>

Horizontal scroll position in PDF user-space points.

§top: Option<f32>

Vertical scroll position in PDF user-space points.

§zoom: Option<f32>

Zoom factor (1.0 == 100%). None preserves current zoom.

§

Fit

/Fit — fit the entire page into the viewer window.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§

FitH

/FitH top — fit page width; align so top is at the top of the viewer.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§top: Option<f32>

Vertical alignment in PDF user-space points.

§

FitV

/FitV left — fit page height; align so left is at the left of the viewer.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§left: Option<f32>

Horizontal alignment in PDF user-space points.

§

FitR

/FitR left bottom right top — fit the given rectangle into the viewer window.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§left: f32

Rectangle’s left edge in PDF user-space points.

§bottom: f32

Rectangle’s bottom edge in PDF user-space points.

§right: f32

Rectangle’s right edge in PDF user-space points.

§top: f32

Rectangle’s top edge in PDF user-space points.

§

FitB

/FitB — fit the page’s bounding box (the area containing non-blank content) into the viewer.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§

FitBH

/FitBH top — fit the page bounding-box width; align so top is at the top of the viewer.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§top: Option<f32>

Vertical alignment in PDF user-space points.

§

FitBV

/FitBV left — fit the page bounding-box height; align so left is at the left of the viewer.

Fields

§page_index: Option<u32>

0-based page index, or None if unresolved.

§left: Option<f32>

Horizontal alignment in PDF user-space points.

§

Named(String)

A named destination — an indirection through the document’s /Names tree. The string is the destination name; resolution to a concrete location requires looking it up in the document catalog’s /Names /Dests entry.

Trait Implementations§

Source§

impl Clone for Destination

Source§

fn clone(&self) -> Destination

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 Destination

Source§

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

Formats the value using the given formatter. Read more

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