Struct ObjectRef

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

Writer for an object reference dictionary. PDF 1.3+

This struct is created by StructChildren::object_ref.

Implementations

impl<'a> ObjectRef<'a>

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

Write the /Pg attribute to specify the page some or all of this structure element is located on.

pub fn object(&mut self, obj: Ref) -> &mut Self

Write the /Obj attribute to specify the object to be referenced. Required.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for ObjectRef<'a>

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

Mutably dereferences the value.

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

type Output = ObjectRef<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for ObjectRef<'a>

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

Start writing the object.