Struct pdf_writer::writers::Pages

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

Writer for a page tree dictionary.

This struct is created by Chunk::pages.

Implementations

impl<'a> Pages<'a>

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

Write the /Parent attribute. Required except in root node.

pub fn kids(&mut self, kids: impl IntoIterator<Item = Ref>) -> &mut Self

Write the /Kids attributes, listing the immediate children of this node in the page tree. Required.

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

Write the /Count attribute, specifying how many descendants this node in the page tree has. This may be different to the length of /Kids when the tree has multiple layers. Required.

pub fn media_box(&mut self, rect: Rect) -> &mut Self

Write the /MediaBox attribute.

pub fn resources(&mut self) -> Resources<'_>

Start writing the /Resources dictionary.

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

pub fn len(&self) -> i32

The number of written pairs.

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Pages<'a>

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

Mutably dereferences the value.

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

type Output = Pages<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Pages<'a>

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

Start writing the object.