Struct pdfium_render::page_objects::PdfPageObjects

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

The page objects contained within a single PdfPage.

Content on a page is structured as a stream of PdfPageObject objects of different types: text objects, image objects, path objects, and so on.

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.

Implementations

impl<'a> PdfPageObjects<'a>

pub fn take_object_from_page(
    &mut self,
    source: &mut PdfPage<'_>,
    source_page_object_index: PdfPageObjectIndex
) -> Result<(), PdfiumError>

Removes a single page object with the given source page object index from the given source PdfPage, adding the object to the end of this PdfPageObjects collection.

If the containing PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the page.

Likewise, if the given source PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the source page.

pub fn take_object_range_from_page(
    &mut self,
    source: &mut PdfPage<'_>,
    source_page_object_range: RangeInclusive<PdfPageObjectIndex>
) -> Result<(), PdfiumError>

Removes one or more page objects with the given range of indices from the given source PdfPage, adding the objects sequentially to the end of this PdfPageObjects collection.

If the containing PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the page.

Likewise, if the given source PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the source page.

pub fn take_all(&mut self, source: &mut PdfPage<'_>) -> Result<(), PdfiumError>

Moves all page objects in the given PdfPage into this PdfPageObjects collection, appending them to the end of this PdfPageObjects collection. The given PdfPage will be drained of all page objects once this operation is completed.

If the containing PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the page.

Likewise, if the given source PdfPage has a content regeneration strategy of PdfPageContentRegenerationStrategy::AutomaticOnEveryChange then content regeneration will be triggered on the source page.

pub fn create_group<F>(
    &'a self,
    predicate: F
) -> Result<PdfPageGroupObject<'a>, PdfiumError>where
    F: Fn(&PdfPageObject<'_>) -> bool,

Creates a new PdfPageGroupObject object group that includes any page objects in this PdfPageObjects collection matching the given predicate function.

pub fn create_empty_group(&self) -> PdfPageGroupObject<'a>

Creates a new PdfPageGroupObject object group that can accept any PdfPageObject in this PdfPageObjects. The newly created group will be empty; you will need to manually add to it the objects you want to manipulate.