Struct pdf_writer::writers::StructTreeRoot

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

Writer for a structure tree root dictionary. PDF 1.3+

This struct is created by Catalog::struct_tree_root.

Implementations

impl<'a> StructTreeRoot<'a>

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

Write the /K attribute to reference the immediate child of this element.

pub fn children(&mut self) -> TypedArray<'_, Ref>

Start writing the /K attribute to reference the immediate children of this element.

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

Start writing the /IDTree attribute to map element identifiers to their corresponding structure element objects. Required if any elements have element identifiers.

pub fn parent_tree(&mut self) -> NumberTree<'_, Ref>

Start writing the /ParentTree attribute to maps structure elements to the content items they belong to. Required if any structure elements contain content items.

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

Write the /ParentTreeNextKey attribute to specify the next available key for the /ParentTree dictionary.

pub fn role_map(&mut self) -> RoleMap<'_>

Start writing the /RoleMap attribute to map structure element names to their approximate equivalents from the standard set of types. PDF 1.4+.

pub fn class_map(&mut self) -> ClassMap<'_>

Start writing the /ClassMap attribute to map objects designating attribute classes to their corresponding attribute objects or arrays thereof.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for StructTreeRoot<'a>

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

Mutably dereferences the value.

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

type Output = StructTreeRoot<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for StructTreeRoot<'a>

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

Start writing the object.