Struct printpdf::types::pdf_document::PdfDocumentReference

pub struct PdfDocumentReference { /* fields omitted */ }

Marker struct for a document. Used to make the API a bit nicer. It simply calls PdfDocument functions.

Implementations

impl PdfDocumentReference

pub fn with_title<S>(self, new_title: S) where
    S: Into<String>, 

Changes the title on both the document info dictionary as well as the metadata

pub fn with_trapping(self, trapping: bool) -> Self

Set the trapping of the document

pub fn with_document_id(self, id: String) -> Self

Sets the document ID (for comparing two PDF documents for equality)

pub fn with_document_version(self, version: u32) -> Self

Set the version of the document

pub fn with_conformance(self, conformance: PdfConformance) -> Self

Changes the conformance of this document. It is recommended to call check_for_errors() after changing it.

pub fn with_creation_date(self, creation_date: OffsetDateTime) -> Self

Sets the creation date on the document.

Per default, the creation date is set to the current time.

pub fn with_metadata_date(self, metadata_date: OffsetDateTime) -> Self

Sets the metadata date on the document.

By default, the metadata date is set to the current time.

pub fn with_mod_date(self, mod_date: OffsetDateTime) -> Self

Sets the modification date on the document. Intended to be used when reading documents that already have a modification date.

pub fn add_page<S>(
    &self,
    x_mm: Mm,
    y_mm: Mm,
    inital_layer_name: S
) -> (PdfPageIndex, PdfLayerIndex) where
    S: Into<String>, 

Create a new pdf page and returns the index of the page

pub fn add_bookmark<S>(&self, name: S, page: PdfPageIndex) where
    S: Into<String>, 

Create a new pdf page and returns the index of the page. If the page already has a bookmark, overwrites it.

pub fn add_external_font<R>(
    &self,
    font_stream: R
) -> Result<IndirectFontRef, Error> where
    R: Read, 

Add a font from a font stream

pub fn add_external_font_data<F>(
    &self,
    bytes: Vec<u8>,
    data: F
) -> Result<IndirectFontRef, Error> where
    F: FontData + 'static, 

Add a font from a custom font backend

pub fn add_builtin_font(
    &self,
    builtin_font: BuiltinFont
) -> Result<IndirectFontRef, Error>

Add a built-in font to the document

Built-in fonts can only be used to print characters that are supported by the Windows-1252 encoding. All other characters will be ignored.

pub fn get_page(&self, page: PdfPageIndex) -> PdfPageReference

Returns the page (for inserting content)

pub fn get_font(&self, font: &IndirectFontRef) -> Option<DirectFontRef>

Returns a direct reference (object ID) to the font from an indirect reference (postscript name)

pub unsafe fn get_inner(self) -> Document

Drops the PDFDocument, returning the inner lopdf::Document. Document may be only half-written, use only in extreme cases

pub fn check_for_errors(&self) -> Result<(), Error>

Checks for invalid settings in the document

pub fn repair_errors(&self, _conformance: PdfConformance) -> Result<(), Error>

Tries to match the document to the given conformance. Errors only on an unrecoverable error.

pub fn save_to_bytes(self) -> Result<Vec<u8>, Error>

Save PDF document to bytes

pub fn save<W: Write>(self, target: &mut BufWriter<W>) -> Result<(), Error>

Save PDF Document, writing the contents to the target