Struct pdf_writer::writers::Outline

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

Writer for an outline dictionary.

This struct is created by PdfWriter::outline.

Implementations

impl<'a> Outline<'a>

pub fn first(&mut self, item: Ref) -> &mut Self

Write the /First attribute which points to the first item in the document’s outline.

pub fn last(&mut self, item: Ref) -> &mut Self

Write the /Last attribute which points to the last item in the document’s outline.

pub fn count(&mut self, count: i32) -> &mut Self

Write the /Count attribute. This tells the viewer how many outline elements (at all levels) are currently visible.

Panics if count is negative.

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 Outline<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Outline<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for Outline<'a>

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

Start writing the object.