Skip to main content

Document

Struct Document 

Source
pub struct Document { /* private fields */ }
Expand description

A parsed PDF document. Load once, then rasterize pages on demand.

Implementations§

Source§

impl Document

Source

pub fn load(bytes: Vec<u8>) -> Result<Self, PdfError>

Parse a PDF document from its raw bytes.

§Errors

Returns PdfError::Parse if the bytes are not a readable PDF, or PdfError::Encrypted if the document is password-protected.

Source

pub fn page_count(&self) -> usize

The number of pages in the document.

Source

pub fn render_page( &self, index: usize, scale: f32, ) -> Result<RenderedPage, PdfError>

Rasterize page index (0-based) at scale (1.0 renders at the native 72-DPI size; 2.0 is twice as large) over an opaque white background, producing straight RGBA8 pixels.

§Errors

Returns PdfError::PageOutOfRange if index >= self.page_count().

Source

pub fn outline(&self) -> Vec<OutlineItem>

Extract the document’s navigation outline (bookmarks) as a tree.

Each entry maps to a 0-based page index where its destination can be resolved. A document with no outline — or a malformed one — yields an empty Vec rather than an error. Named destinations (/Names/Dests name trees) and remote/URI actions are not resolved: those entries keep their title but report page = None.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.