Struct RoleMap 

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

Writer for a role map dictionary. PDF 1.4+

This struct is created by StructTreeRoot::role_map.

For PDF 2.0 documents, note that this mapping maps to the PDF 1.7 roles. For a namespace-aware role-mapping mechanism, see Namespace::role_map_ns.

Implementations

impl RoleMap<'_>

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

Write an entry mapping a custom name to a pre-defined role.

Methods from Deref<Target = TypedDict<'a, Name<'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 pair(&mut self, key: Name<'_>, value: T) -> &mut Self

where T: Primitive,

Write a key-value pair.

pub fn pairs<'n>( &mut self, pairs: impl IntoIterator<Item = (Name<'n>, T)>, ) -> &mut Self

where T: Primitive,

Write a sequence of key-value pairs.

pub fn insert<'b>(&'b mut self, key: Name<'_>) -> <T as Rewrite<'b>>::Output

where T: Writer<'a> + Rewrite<'b>,

Start writing a pair with the typed writer.

Returns T but with its lifetime rewritten from 'a to 'b.

Trait Implementations

impl<'a> Deref for RoleMap<'a>

type Target = TypedDict<'a, Name<'a>>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for RoleMap<'a>

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

Mutably dereferences the value.

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

type Output = RoleMap<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for RoleMap<'a>

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

Start writing the object.