Enum pdfium_render::page_object::PdfPageObject

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

A single object on a PdfPage.

Variants

Text(PdfPageTextObject<'a>)

Path(PdfPagePathObject<'a>)

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

impl<'a> PdfPageObject<'a>

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.

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.

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.

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

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

pub fn as_text_object_mut(&mut self) -> Option<&mut PdfPageTextObject<'a>>

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

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

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

pub fn as_path_object_mut(&mut self) -> Option<&mut PdfPagePathObject<'a>>

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

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

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

pub fn as_image_object_mut(&mut self) -> Option<&mut PdfPageImageObject<'a>>

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

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

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

pub fn as_shading_object_mut(&mut self) -> Option<&mut PdfPageShadingObject<'a>>

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

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

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

pub fn as_form_fragment_object_mut(
    &mut self
) -> Option<&mut PdfPageFormFragmentObject<'a>>

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

Trait Implementations

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

fn drop(&mut self)

Closes this PdfPageObject, releasing held memory.

impl<'a> From<PdfPageFormFragmentObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageFormFragmentObject<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfPageImageObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageImageObject<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfPagePathObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPagePathObject<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfPageShadingObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageShadingObject<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfPageTextObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageTextObject<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<PdfPageUnsupportedObject<'a>> for PdfPageObject<'a>

fn from(object: PdfPageUnsupportedObject<'a>) -> Self

Converts to this type from the input type.