Enum pdfium_render::page_object::PdfPageObject

source · [−]

pub enum PdfPageObject<'a> {
    Text(PdfPageTextObject<'a>),
    Path(PdfPagePathObject<'a>),
    Image(PdfPageImageObject<'a>),
    Shading(PdfPageShadingObject<'a>),
    FormFragment(PdfPageFormFragmentObject<'a>),
    Unsupported(PdfPageUnsupportedObject<'a>),
}

Expand description

A single object on a PdfPage.

Variants

`Image(PdfPageImageObject<'a>)`

`Shading(PdfPageShadingObject<'a>)`

`FormFragment(PdfPageFormFragmentObject<'a>)`

`Unsupported(PdfPageUnsupportedObject<'a>)`

Common properties shared by all PdfPageObject types can still be accessed for page objects not recognized by Pdfium, but object-specific functionality will be unavailable.

Implementations

source

impl<'a> PdfPageObject<'a>

source

pub fn object_type(&self) -> PdfPageObjectType

The object type of this PdfPageObject.

Note that Pdfium does not support or recognize all PDF page object types. For instance, Pdfium does not currently support or recognize the External Object (“XObject”) page object type supported by Adobe Acrobat and Foxit’s commercial PDF SDK. In these cases, Pdfium will return PdfPageObjectType::Unsupported.

source

pub fn is_supported(&self) -> bool

Returns true if this PdfPageObject has an object type other than PdfPageObjectType::Unsupported.

The PdfPageObject::as_text_object(), PdfPageObject::as_path_object(), PdfPageObject::as_image_object(), PdfPageObject::as_shading_object(), and PdfPageObject::as_form_fragment_object() functions can be used to access properties and functions pertaining to a specific page object type.

source

pub fn is_unsupported(&self) -> bool

Returns true if this PdfPageObject has an object type of PdfPageObjectType::Unsupported.

Common properties shared by all PdfPageObject types can still be accessed for page objects not recognized by Pdfium, but object-specific functionality will be unavailable.

source

pub fn as_text_object(&self) -> Option<&PdfPageTextObject<'_>>

Returns the underlying PdfPageTextObject for this PdfPageObject, if this page object has an object type of PdfPageObjectType::Text.

source

pub fn as_path_object(&self) -> Option<&PdfPagePathObject<'_>>

Returns the underlying PdfPagePathObject for this PdfPageObject, if this page object has an object type of PdfPageObjectType::Path.

source

pub fn as_image_object(&self) -> Option<&PdfPageImageObject<'_>>

Returns the underlying PdfPageImageObject for this PdfPageObject, if this page object has an object type of PdfPageObjectType::Image.

source

pub fn as_shading_object(&self) -> Option<&PdfPageShadingObject<'_>>

Returns the underlying PdfPageShadingObject for this PdfPageObject, if this page object has an object type of PdfPageObjectType::Shading.

source

pub fn as_form_fragment_object(&self) -> Option<&PdfPageFormFragmentObject<'_>>

Returns the underlying PdfPageFormFragmentObject for this PdfPageObject, if this page object has an object type of PdfPageObjectType::FormFragment.

Trait Implementations

source

impl<'a> Drop for PdfPageObject<'a>

source

fn drop(&mut self)

Closes this PdfPageObject, releasing held memory.

Auto Trait Implementations

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

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

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

impl<'a> Unpin for PdfPageObject<'a>

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

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,

const: unstable · source

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

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<'a, T> PdfPageObjectCommon<'a> for T where
T: PdfPageObjectPrivate<'a>,

source

fn has_transparency(&self) -> bool

Returns true if this PdfPageObject contains transparency.

source

fn bounds(&self) -> Result<PdfRect, PdfiumError>

Returns the bounding box of this PdfPageObject.

source

fn transform(&mut self, a: f64, b: f64, c: f64, d: f64, e: f64, f: f64)

Applies the given transformation, expressed as six values representing the six configurable elements of a nine-element 3x3 PDF transformation matrix, to this PdfPageObject. Read more

source