Struct Document 

pub struct Document { /* private fields */ }

A PDF being built. See the module documentation.

Implementations

impl Document

pub fn new(version: &str) -> Result<Document, WriteError>

Start a document. version is "1.0" to "1.7" ("1.4" for the widest readers).

pub fn page_count(&self) -> usize

pub fn add_icc_profile( &mut self, profile: Vec<u8>, components: u8, ) -> Result<IccId, WriteError>

Register an ICC profile (components 1 or 3) to colour-tag JPEGs. Needs PDF 1.3+.

pub fn add_page( &mut self, width_pt: f64, height_pt: f64, ) -> Result<PageId, WriteError>

Append an empty page of width_pt x height_pt (1/72 inch).

pub fn place_jpeg( &mut self, page: PageId, jpeg: Vec<u8>, icc: Option<IccId>, ) -> Result<JpegInfo, WriteError>

Draw jpeg over the whole of page (q w 0 0 h 0 0 cm /Im0 Do Q). icc tags it with a profile whose component count equals the JPEG’s; None uses DeviceRGB or DeviceGray.

pub fn add_jpeg_page( &mut self, width_pt: f64, height_pt: f64, jpeg: Vec<u8>, icc: Option<IccId>, ) -> Result<PageId, WriteError>

Self::add_page then Self::place_jpeg. On an error no page is added.

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

The finished file. A document with no pages has an empty page tree.

Panics

Only if a font that Self::add_font accepted cannot be subset (a damaged table the subsetter rejects); use Self::try_finish to get that as an error. A document without text cannot panic.

pub fn try_finish(&self) -> Result<Vec<u8>, WriteError>

Self::finish returning font subsetting failures as errors.

pub fn add_font( &mut self, bytes: Vec<u8>, face_index: u32, ) -> Result<FontId, WriteError>

Register a TrueType font for Self::draw_text. face_index is 0 for a single-face file. Refused when the font does not parse or its fsType forbids embedding or subsetting. Needs feature fonts.

pub fn measure_text( &self, font: FontId, size_pt: f64, text: &str, ) -> Result<f64, WriteError>

Width of text in points at size_pt: the sum of the font’s advances (no kerning), for right-aligning or centring before Self::draw_text. Refuses a missing glyph.

pub fn draw_text( &mut self, page: PageId, font: FontId, size_pt: f64, x_pt: f64, y_pt: f64, rgb: Option<[f64; 3]>, text: &str, ) -> Result<(), WriteError>

Draw text on page with its baseline starting at (x_pt, y_pt) from the page’s bottom-left, size_pt high. rgb is 0.0 to 1.0 per channel (None leaves the default black). One call is one run: no wrapping, shaping or kerning. Every character needs a glyph in the font (WriteError::MissingGlyph otherwise, nothing is drawn).

pub fn write_to(&self, path: &Path) -> Result<()>

Write Self::finish to path through crate::commit::write_atomic (temp sibling, flush, rename, directory sync): the one documented way to put a new file on disk. Path authorization is the caller’s job.