Struct pdf_writer::writers::Destination

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

Writer for a destination array.

A dictionary mapping to this struct is created by Chunk::destinations. This struct is also created by Action::destination.

Implementations

impl<'a> Destination<'a>

pub fn page(self, page: Ref) -> Self

The target page. Required.

pub fn xyz(self, left: f32, top: f32, zoom: Option<f32>)

Write the /XYZ command which skips to the specified coordinated.

pub fn fit(self)

Write the /Fit command which fits all of the referenced page on screen.

pub fn fit_horizontal(self, top: f32)

Write the /FitH command which fits the referenced page to the screen width and skips to the specified offset.

pub fn fit_vertical(self, left: f32)

Write the /FitV command which fits the referenced page to the screen height and skips to the specified offset.

pub fn fit_rect(self, rect: Rect)

Write the /FitR command which fits the rectangle argument on the screen.

pub fn fit_bounding_box(self)

Write the /FitB command which fits all of the referenced page’s content on screen. PDF 1.1+.

pub fn fit_bounding_box_horizontal(self, top: f32)

Write the /FitBH command which fits the referenced page’s content to the screen width and skips to the specified offset. PDF 1.1+.

pub fn fit_bounding_box_vertical(self, left: f32)

Write the /FitBV command which fits the referenced page’s content to the screen height and skips to the specified offset. PDF 1.1+.

Methods from Deref<Target = Array<'a>>

pub fn len(&self) -> i32

The number of written items.

pub fn is_empty(&self) -> bool

Whether no items have been written so far.

pub fn push(&mut self) -> Obj<'_>

Start writing an arbitrary item.

pub fn item<T: Primitive>(&mut self, value: T) -> &mut Self

Write an item with a primitive value.

This is a shorthand for array.push().primitive(value).

pub fn items<T: Primitive>( &mut self, values: impl IntoIterator<Item = T> ) -> &mut Self

Write a sequence of items with primitive values.

Trait Implementations

impl<'a> Deref for Destination<'a>

type Target = Array<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for Destination<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, 'any> Rewrite<'a> for Destination<'any>

type Output = Destination<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Destination<'a>

fn start(obj: Obj<'a>) -> Self

Start writing the object.