Struct pdf_writer::PdfWriter

pub struct PdfWriter { /* fields omitted */ }

The root writer.

Implementations

impl PdfWriter

Core methods.

pub fn new(major: i32, minor: i32) -> Self

Create a new PDF writer with the default buffer capacity (currently 8 KB).

This already writes the PDF header containing the (major, minor) version.

pub fn with_capacity(capacity: usize, major: i32, minor: i32) -> Self

Create a new PDF writer with the specified initial buffer capacity.

This already writes the PDF header containing the (major, minor) version.

pub fn set_indent(&mut self, indent: usize)

Set the indent level per layer of nested objects.

Default value: 0.

pub fn finish(self, catalog_id: Ref) -> Vec<u8>

Write the cross-reference table and file trailer and return the underlying buffer.

pub fn len(&self) -> usize

The number of bytes that were written so far.

impl PdfWriter

Indirect objects.

pub fn indirect(&mut self, id: Ref) -> Obj<'_, IndirectGuard>

Start writing an indirectly referenceable object.

pub fn catalog(&mut self, id: Ref) -> Catalog<'_>

Start writing a document catalog.

pub fn pages(&mut self, id: Ref) -> Pages<'_>

Start writing a page tree.

pub fn page(&mut self, id: Ref) -> Page<'_>

Start writing a page.

pub fn outline(&mut self, id: Ref) -> Outline<'_>

Start writing an outline.

pub fn outline_item(&mut self, id: Ref) -> OutlineItem<'_>

Start writing an outline item.

pub fn destinations(&mut self, id: Ref) -> Destinations<'_>

Start writing a named destination dictionary.

pub fn type1_font(&mut self, id: Ref) -> Type1Font<'_>

Start writing a Type-1 font.

pub fn type0_font(&mut self, id: Ref) -> Type0Font<'_>

Start writing a Type-0 font.

pub fn cid_font(&mut self, id: Ref, subtype: CidFontType) -> CidFont<'_>

Start writing a CID font.

pub fn font_descriptor(&mut self, id: Ref) -> FontDescriptor<'_>

Start writing a font descriptor.

impl PdfWriter

Streams.

pub fn stream<'a>(&'a mut self, id: Ref, data: &'a [u8]) -> Stream<'a>

Start writing an indirectly referenceable stream.

The stream data and the /Length field are written automatically. You can add additional key-value pairs to the stream dictionary with the returned stream writer.

pub fn cmap<'a>(&'a mut self, id: Ref, cmap: &'a [u8]) -> CmapStream<'a>

Start writing a character map stream.

If you want to use this for a /ToUnicode CMap, you can use the UnicodeCmap builder to construct the data.

pub fn image<'a>(&'a mut self, id: Ref, samples: &'a [u8]) -> ImageStream<'a>

Start writing an XObject image stream.

Trait Implementations

impl Debug for PdfWriter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.