Struct PdfDocument

pub struct PdfDocument {
    pub metadata: PdfMetadata,
    pub resources: PdfResources,
    pub bookmarks: PageAnnotMap,
    pub pages: Vec<PdfPage>,
}

Parsed PDF document

Fields

metadata: PdfMetadata

Metadata about the document (author, info, XMP metadata, etc.)

resources: PdfResources

Resources shared between pages, such as fonts, XObjects, images, forms, ICC profiles, etc.

bookmarks: PageAnnotMap

Document-level bookmarks (used for the outline)

pages: Vec<PdfPage>

Page contents

Implementations

impl PdfDocument

pub fn shape_text( &self, text: &str, font_id: &FontId, options: &TextShapingOptions, ) -> Option<ShapedText>

Looks up a text and shapes it without coordinate transformation.

Only returns None on an invalid FontId.

pub fn new(name: &str) -> Self

pub fn parse( bytes: &[u8], opts: &PdfParseOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Result<Self, String>

Parses a PDF

pub async fn parse_async( bytes: &[u8], opts: &PdfParseOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Result<Self, String>

pub fn add_graphics_state( &mut self, gs: ExtendedGraphicsState, ) -> ExtendedGraphicsStateId

pub fn add_layer(&mut self, layer: &Layer) -> LayerInternalId

pub fn add_font(&mut self, font: &ParsedFont) -> FontId

pub fn add_image(&mut self, image: &RawImage) -> XObjectId

Adds an image to the internal resources

pub fn add_xobject(&mut self, parsed_svg: &ExternalXObject) -> XObjectId

Adds an external XObject stream (usually SVG or other stream) to the PDF resources so that it can be later be invoked with UseXobject { id }

pub fn add_bookmark(&mut self, name: &str, page: usize) -> PageAnnotId

Adds a new page-level bookmark on page $page, returning the bookmarks internal ID

pub fn from_html( html: &str, images: &BTreeMap<String, Base64OrRaw>, fonts: &BTreeMap<String, Base64OrRaw>, options: &GeneratePdfOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Result<Self, String>

Renders HTML to pages

pub async fn from_html_async( html: &str, images: &BTreeMap<String, Base64OrRaw>, fonts: &BTreeMap<String, Base64OrRaw>, options: &GeneratePdfOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Result<Self, String>

pub fn page_to_svg( &self, page: usize, opts: &PdfToSvgOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Option<String>

Renders a PDF Page into an SVG String. Returns None on an invalid page number (note: 1-indexed, so the first PDF page is “page 1”, not “page 0”).

pub async fn page_to_svg_async( &self, page: usize, opts: &PdfToSvgOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Option<String>

pub fn with_pages(&mut self, pages: Vec<PdfPage>) -> &mut Self

Replaces document.pages with the new pages

pub fn save_writer<W: Write>( &self, w: &mut W, opts: &PdfSaveOptions, warnings: &mut Vec<PdfWarnMsg>, )

Serializes the PDF document and writes it to a writer

pub fn save( &self, opts: &PdfSaveOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Vec<u8>

Serializes the PDF document to bytes

pub async fn save_async( &self, opts: &PdfSaveOptions, warnings: &mut Vec<PdfWarnMsg>, ) -> Vec<u8>

Trait Implementations

impl Clone for PdfDocument

fn clone(&self) -> PdfDocument

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PdfDocument

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

Formats the value using the given formatter.

impl Default for PdfDocument

fn default() -> PdfDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PdfDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PdfDocument

fn eq(&self, other: &PdfDocument) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PdfDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PdfDocument