Struct pdf_writer::writers::Catalog

pub struct Catalog<'a> { /* fields omitted */ }

Writer for a document catalog dictionary.

This struct is created by PdfWriter::catalog.

Implementations

impl<'a> Catalog<'a>

pub fn pages(&mut self, id: Ref) -> &mut Self

Write the /Pages attribute pointing to the root page tree.

pub fn page_layout(&mut self, layout: PageLayout) -> &mut Self

Write the /PageLayout attribute to determine how the viewer will display the document’s pages.

pub fn page_mode(&mut self, mode: PageMode) -> &mut Self

Write the /PageMode attribute to set which chrome elements the viewer should show.

pub fn outlines(&mut self, id: Ref) -> &mut Self

Write the /Outlines attribute pointing to the root outline dictionary.

pub fn destinations(&mut self, id: Ref) -> &mut Self

Write the /Dests attribute pointing to a named destinations dictionary. PDF 1.1+.

pub fn viewer_preferences(&mut self) -> ViewerPreferences<'_>

Start writing the /ViewerPreferences dictionary. PDF 1.2+.

pub fn page_labels(&mut self) -> Dict<'_>

Write the /PageLabels attribute to specify the page labels. PDF 1.3+.

pub fn lang(&mut self, lang: TextStr<'_>) -> &mut Self

Write the /Lang attribute to specify the language of the document as a RFC 3066 language tag. PDF 1.4+.

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

pub fn len(&self) -> i32

The number of written pairs.

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

pub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self

Write a pair with a primitive value.

This is a shorthand for dict.insert(key).primitive(value).

pub fn pairs<'n, T: Primitive>(
    &mut self,
    pairs: impl IntoIterator<Item = (Name<'n>, T)>
) -> &mut Self

Write a sequence of pairs with primitive values.

Trait Implementations

impl<'a> Deref for Catalog<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Catalog<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for Catalog<'a>

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

Start writing the object.