Struct Names

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

Writer for a names dictionary.

This dictionary can map various objects to names using name trees. This struct is created by Catalog::names.

Implementations

impl Names<'_>

pub fn destinations(&mut self) -> NameTree<'_, Ref>

Start writing the /Dests attribute to provide associations for destinations.

pub fn appearances(&mut self) -> NameTree<'_, Ref>

Start writing the /AP attribute to provide associations for appearance streams. PDF 1.3+.

pub fn javascript(&mut self) -> NameTree<'_, Ref>

Start writing the /JavaScript attribute to provide associations for JavaScript actions. PDF 1.3+.

pub fn pages(&mut self) -> NameTree<'_, Ref>

Start writing the /Pages attribute to name pages. PDF 1.3+.

pub fn templates(&mut self) -> NameTree<'_, Ref>

Start writing the /Template attribute to name pages outside of the page tree as templates for interactive forms. PDF 1.3+.

pub fn capture_ids(&mut self) -> NameTree<'_, Ref>

Start writing the /IDS attribute to map identifiers to Web Capture content sets. PDF 1.3+.

pub fn capture_urls(&mut self) -> NameTree<'_, Ref>

Start writing the /URLS attribute to map URLs to Web Capture content sets. PDF 1.3+.

pub fn embedded_files(&mut self) -> NameTree<'_, Ref>

Start writing the /EmbeddedFiles attribute to name embedded files. PDF 1.4+.

Note that this key is forbidden in PDF/A-1, and restricted in PDF/A-2 and PDF/A-4.

pub fn alternate_presentations(&mut self) -> NameTree<'_, Ref>

Start writing the /AlternatePresentations attribute to name alternate presentations. PDF 1.4+.

Note that this key is forbidden in PDF/A.

pub fn renditions(&mut self) -> NameTree<'_, Ref>

Start writing the /Renditions attribute to name renditions. The names must conform to Unicode. PDF 1.5+.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Names<'a>

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

Mutably dereferences the value.

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

type Output = Names<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Names<'a>

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

Start writing the object.