Struct pdf_writer::writers::MarkedRef

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

Writer for a marked content reference dictionary. PDF 1.3+

This struct is created by StructChildren::marked_content_ref and StructElement::marked_content_child.

Implementations

impl<'a> MarkedRef<'a>

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

Write the /Pg attribute to specify the page the referenced marked content sequence is located on.

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

Write the /Stm attribute to specify the content stream containing this marked content sequence if it was not on a page. If this content is missing, writing the page attribute here or in the associated structure element is required.

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

Write the /StmOwn attribute to specify which object owns the content stream specified by the /Stm attribute.

pub fn marked_content_id(&mut self, id: i32) -> &mut Self

Write the /MCID attribute to specify the integer marked content identifier. 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 MarkedRef<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for MarkedRef<'a>

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

Mutably dereferences the value.

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

type Output = MarkedRef<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for MarkedRef<'a>

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

Start writing the object.