Struct pdf_writer::writers::DocumentInfo

pub struct DocumentInfo<'a> { /* fields omitted */ }

Writer for a document information dictionary.

This struct is created by PdfWriter::document_info.

Implementations

impl<'a> DocumentInfo<'a>

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

Write the /Title attribute to set the document’s title. PDF 1.1+.

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

Write the /Author attribute to set the document’s author.

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

Write the /Subject attribute to set the document’s subject. PDF 1.1+.

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

Write the /Keywords attribute to set terms associated to the document. PDF 1.1+.

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

Write the /Creator attribute to set the name of the product that converted or wrote the file that this PDF has been converted from.

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

Write the /Producer attribute to set the name of the product that converted or wrote this PDF.

pub fn creation_date(&mut self, date: Date) -> &mut Self

Write the /CreationDate attribute to set the date the document was created.

pub fn modified_date(&mut self, date: Date) -> &mut Self

Write the /ModDate attribute to set the date the document was last modified.

Required if /PieceInfo is set in the document catalog.

pub fn trapped(&mut self, trapped: TrappingStatus) -> &mut Self

Write the /Trapped attribute to set whether the document is fully or partially trapped. PDF 1.3+.

Methods from Deref<Target = Dict<'a>>

pub fn len(&self) -> i32

The number of written pairs.

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

type Target = Dict<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for DocumentInfo<'a>

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

Mutably dereferences the value.

impl<'a> Writer<'a> for DocumentInfo<'a>

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

Start writing the object.