Struct pdfium_render::page::PdfPage

source · [−]

pub struct PdfPage<'a> { /* private fields */ }

Expand description

A single page in a PdfDocument.

Implementations

source

impl<'a> PdfPage<'a>

source

pub fn index(&self) -> PdfPageIndex

Returns the zero-based page index of this PdfPage in its containing PdfDocument.

source

pub fn label(&self) -> Option<String>

Returns the label assigned to this PdfPage, if any.

source

pub fn width(&self) -> PdfPoints

Returns the width of this PdfPage in device-independent points. One point is 1/72 inches, roughly 0.358 mm.

source

pub fn height(&self) -> PdfPoints

Returns the height of this PdfPage in device-independent points. One point is 1/72 inches, roughly 0.358 mm.

source

pub fn page_size(&self) -> PdfRect

Returns the width and height of this PdfPage expressed as a PdfRect.

source

pub fn orientation(&self) -> PdfPageOrientation

Returns PdfPageOrientation::Landscape if the width of this PdfPage is greater than its height; otherwise returns PdfPageOrientation::Portrait.

source

pub fn is_portrait(&self) -> bool

Returns true if this PdfPage has orientation PdfPageOrientation::Portrait.

source

pub fn is_landscape(&self) -> bool

Returns true if this PdfPage has orientation PdfPageOrientation::Landscape.

source

pub fn rotation(&self) -> Result<PdfBitmapRotation, PdfiumError>

Returns any intrinsic rotation encoded into this document indicating a rotation should be applied to this PdfPage during rendering.

source

pub fn set_rotation(&mut self, rotation: PdfBitmapRotation)

Sets the intrinsic rotation that should be applied to this PdfPage during rendering.

source

pub fn has_transparency(&self) -> bool

Returns true if any object on the page contains transparency.

source

pub fn boundaries(&self) -> PdfPageBoundaries<'_>

Returns the collection of bounding boxes defining the extents of this PdfPage.

source

pub fn paper_size(&self) -> PdfPagePaperSize

Returns the paper size of this PdfPage.

source

pub fn text(&self) -> Result<PdfPageText<'_>, PdfiumError>

Returns the collection of text boxes contained within this PdfPage.

source

pub fn objects(&self) -> PdfPageObjects<'_>

Returns the collection of page objects contained within this PdfPage.

source

pub fn get_bitmap_with_config(
&self,
config: &PdfBitmapConfig
) -> Result<PdfBitmap<'_>, PdfiumError>

Returns a PdfBitmap using pixel dimensions, rotation settings, and rendering options configured in the given PdfBitmapConfig.

See also PdfPage::get_bitmap(), which directly creates a PdfBitmap object from this page using caller-specified pixel dimensions and page rotation settings.

source

pub fn get_bitmap(
 &self,
 width: u16,
 height: u16,
 rotation: Option<PdfBitmapRotation>
) -> Result<PdfBitmap<'_>, PdfiumError>

Returns a PdfBitmap with the given pixel dimensions and render-time rotation for this PdfPage containing the rendered content of this PdfPage.

It is the responsibility of the caller to ensure the given pixel width and height correctly maintain the page’s aspect ratio.

See also PdfPage::get_bitmap_with_config(), which calculates the correct pixel dimensions, rotation settings, and rendering options to apply from a PdfBitmapConfig object.

Trait Implementations

source

impl<'a> Drop for PdfPage<'a>

source

fn drop(&mut self)

Closes the PdfPage, releasing held memory.

Auto Trait Implementations

impl<'a> !RefUnwindSafe for PdfPage<'a>

impl<'a> !Send for PdfPage<'a>

impl<'a> !Sync for PdfPage<'a>

impl<'a> Unpin for PdfPage<'a>

impl<'a> !UnwindSafe for PdfPage<'a>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct pdfium_render::page::PdfPage

Implementations

impl<'a> PdfPage<'a>

pub fn index(&self) -> PdfPageIndex

pub fn label(&self) -> Option<String>

pub fn width(&self) -> PdfPoints

pub fn height(&self) -> PdfPoints

pub fn page_size(&self) -> PdfRect

pub fn orientation(&self) -> PdfPageOrientation

pub fn is_portrait(&self) -> bool

pub fn is_landscape(&self) -> bool

pub fn rotation(&self) -> Result<PdfBitmapRotation, PdfiumError>

pub fn set_rotation(&mut self, rotation: PdfBitmapRotation)

pub fn has_transparency(&self) -> bool

pub fn boundaries(&self) -> PdfPageBoundaries<'_>

pub fn paper_size(&self) -> PdfPagePaperSize

pub fn text(&self) -> Result<PdfPageText<'_>, PdfiumError>

pub fn objects(&self) -> PdfPageObjects<'_>

pub fn get_bitmap_with_config( &self, config: &PdfBitmapConfig) -> Result<PdfBitmap<'_>, PdfiumError>

pub fn get_bitmap( &self, width: u16, height: u16, rotation: Option<PdfBitmapRotation>) -> Result<PdfBitmap<'_>, PdfiumError>

Trait Implementations

impl<'a> Drop for PdfPage<'a>

fn drop(&mut self)

Auto Trait Implementations

impl<'a> !RefUnwindSafe for PdfPage<'a>

impl<'a> !Send for PdfPage<'a>

impl<'a> !Sync for PdfPage<'a>

impl<'a> Unpin for PdfPage<'a>

impl<'a> !UnwindSafe for PdfPage<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

pub fn get_bitmap_with_config(
&self,
config: &PdfBitmapConfig
) -> Result<PdfBitmap<'_>, PdfiumError>

pub fn get_bitmap(
&self,
width: u16,
height: u16,
rotation: Option<PdfBitmapRotation>
) -> Result<PdfBitmap<'_>, PdfiumError>

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

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

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

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

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

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