Struct pdf_writer::PdfWriter

source · [−]

pub struct PdfWriter { /* private fields */ }

Expand description

The root writer.

Implementations

source

impl PdfWriter

Core methods.

source

pub fn new() -> Self

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

source

pub fn with_capacity(capacity: usize) -> Self

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

source

pub fn set_version(&mut self, major: u8, minor: u8)

Set the PDF version.

The version is not semantically important to the writer, but must be present in the output document.

Default value: 1.7.

source

pub fn len(&self) -> usize

The number of bytes that were written so far.

source

pub fn finish(self) -> Vec<u8>

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

Panics if any indirect reference id was used twice.

source

impl PdfWriter

Indirect objects and streams.

source

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

Start writing an indirectly referenceable object.

source

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.

You can use this function together with a Content stream builder to provide a page’s contents.

use pdf_writer::{PdfWriter, Content, Ref};

// Create a simple content stream.
let mut content = Content::new();
content.rect(50.0, 50.0, 50.0, 50.0);
content.stroke();

// Create a writer and write the stream.
let mut writer = PdfWriter::new();
writer.stream(Ref::new(1), &content.finish());

This crate does not do any compression for you. If you want to compress a stream, you have to pass already compressed data into this function and specify the appropriate filter in the stream dictionary.

For example, if you want to compress your content stream with DEFLATE, you could do something like this:

use pdf_writer::{PdfWriter, Content, Ref, Filter};
use miniz_oxide::deflate::{compress_to_vec_zlib, CompressionLevel};

// Create a simple content stream.
let mut content = Content::new();
content.rect(50.0, 50.0, 50.0, 50.0);
content.stroke();

// Compress the stream.
let level = CompressionLevel::DefaultLevel as u8;
let compressed = compress_to_vec_zlib(&content.finish(), level);

// Create a writer, write the compressed stream and specify that it
// needs to be decoded with a FLATE filter.
let mut writer = PdfWriter::new();
writer.stream(Ref::new(1), &compressed).filter(Filter::FlateDecode);

For all the specialized stream functions below, it works the same way: You can pass compressed data and specify a filter.

Panics if the stream length exceeds i32::MAX.

source

impl PdfWriter

Document structure.

source

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

Start writing the document catalog. Required.

This will also register the document catalog with the file trailer, meaning that you don’t need to provide the given id anywhere else.

source

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

Start writing the document information.

This will also register the document information dictionary with the file trailer, meaning that you don’t need to provide the given id anywhere else.

source