Struct NamespaceRoleMap 

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

Writer for a namespace role map dictionary. PDF 2.0+

This struct is created by Namespace::role_map_ns.

Implementations

impl NamespaceRoleMap<'_>

pub fn to_pdf_1_7(&mut self, name: Name<'_>, role: StructRole) -> &mut Self

Write an entry mapping a custom structure type to an element in the standard (PDF 1.7) namespace.

pub fn to_namespace( &mut self, name: Name<'_>, role: Name<'_>, ns_ref: Ref, ) -> &mut Self

Write an entry mapping a custom structure type to an element in the namespace referenced by the namespace dictionary the value of the ns_ref parameter points to.

pub fn to_pdf_2_0( &mut self, name: Name<'_>, role: StructRole2, pdf_2_ns: Ref, ) -> &mut Self

Write an entry mapping a custom structure type to an element in the PDF 2.0 namespace.

The pdf_2_ns parameter is an indirect reference to a PDF 2.0 namespace dictionary. You can create this dictionary by using Chunk::namespace and then calling Namespace::pdf_2_ns on the returned writer.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for NamespaceRoleMap<'a>

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

Mutably dereferences the value.

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

type Output = NamespaceRoleMap<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for NamespaceRoleMap<'a>

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

Start writing the object.