Struct pdf_writer::writers::Reference

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

Writer for an external XObject reference dictionary. PDF 1.4+.

This struct is created by FormXObject::reference.

Implementations

impl<'a> Reference<'a>

pub fn file_spec(&mut self) -> FileSpec<'_>

Start writing the /F attribute to set a file specification dictionary. Required.

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

Write the /Page attribute to set the page number. Setting the attribute through either this function or Self::page_label is required. Page indices start at 0.

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

Write the /Page attribute to set the page label. Setting the attribute through either this function or Self::page_number is required.

pub fn id(&mut self, id: [Str<'_>; 2]) -> &mut Self

Write the /ID attribute to set the file identifier.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Reference<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for Reference<'a>

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

Start writing the object.