Struct pdf_writer::writers::PageLabel

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

Writer for a page label dictionary.

Implementations

impl<'a> PageLabel<'a>

pub fn style(&mut self, style: NumberingStyle) -> &mut Self

Write the /S attribute to set the page label’s numbering style.

If this attribute is omitted, only the prefix will be used, there will be no page number.

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

Write the /P attribute to set the page label’s prefix.

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

Write the /St attribute to set the page label’s offset.

This must be greater or equal to 1 if set.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for PageLabel<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for PageLabel<'a>

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

Start writing the object.