Struct pdf_writer::writers::Attributes

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

Writer for an attribute dictionary. PDF 1.4+

This struct must set the /O attribute by calling any of the methods. This struct is created by ClassMap::single. An array of this struct is created by StructElement::attributes and ClassMap::multiple.

Implementations

impl<'a> Attributes<'a>

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

Write the /O attribute to set the owner.

Should not be called when using any of the other methods.

pub fn user(&mut self) -> TypedArray<'_, UserProperty<'_>>

Set the /O attribute to user-defined and start writing the /P array with user properties. PDF 1.6+

pub fn layout(self) -> LayoutAttributes<'a>

Set the /O attribute to Layout to start writing layout parameters.

pub fn list(self) -> ListAttributes<'a>

Set the /O attribute to List to start writing list attributes.

pub fn field(self) -> FieldAttributes<'a>

Set the /O attribute to PrintField to start writing attributes for the appearance of form fields. PDF 1.6+

pub fn table(self) -> TableAttributes<'a>

Set the /O attribute to Table to start writing table attributes.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Attributes<'a>

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

Mutably dereferences the value.

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

type Output = Attributes<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for Attributes<'a>

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

Start writing the object.