Struct UserProperty

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

Writer for an user property dictionary. PDF 1.6+

An array of this struct is created by Attributes::user.

Implementations

impl<'a> UserProperty<'a>

pub fn name(&mut self, name: TextStr<'_>) -> &mut Self

Write the /N attribute to set the name of the property.

pub fn value(&mut self) -> Obj<'_>

Start writing the /V attribute to set the value of the property.

pub fn format(&mut self, format: TextStr<'_>) -> &mut Self

Write the /F attribute to set the format of the property.

pub fn hidden(&mut self, hide: bool) -> &mut Self

Write the /H attribute to determine whether this property is hidden.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for UserProperty<'a>

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

Mutably dereferences the value.

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

type Output = UserProperty<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for UserProperty<'a>

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

Start writing the object.