Struct Artifact

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

Writer for an actifact property list dictionary. PDF 1.4+.

Required for marking up pagination artifacts in some PDF/A profiles.

Implementations

impl<'a> Artifact<'a>

pub fn kind(&mut self, kind: ArtifactType) -> &mut Self

Write the /Type entry to set the type of artifact. Specific to artifacts. PDF 1.4+.

pub fn subtype(&mut self, subtype: ArtifactSubtype<'_>) -> &mut Self

Write the /Subtype entry to set the subtype of pagination artifacts. Specific to artifacts. PDF 1.7+.

pub fn bounding_box(&mut self, bbox: Rect) -> &mut Self

Write the /BBox entry to set the bounding box of the artifact. Specific to artifacts. Required for background artifacts. PDF 1.4+.

pub fn attached( &mut self, attachment: impl IntoIterator<Item = ArtifactAttachment>, ) -> &mut Self

Write the /Attached entry to set where the artifact is attached to the page. Only for pagination and full-page background artifacts. Specific to artifacts. PDF 1.4+.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Artifact<'a>

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

Mutably dereferences the value.

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

type Output = Artifact<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Artifact<'a>

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

Start writing the object.