Enum PdfPageObject

Source

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

Expand description

A single renderable object on a PdfPage.

Variants§

§

Text(PdfPageTextObject<'a>)

A page object containing renderable text.

§

Path(PdfPagePathObject<'a>)

A page object containing a renderable vector path.

§

Image(PdfPageImageObject<'a>)

A page object containing a renderable bitmapped image.

§

Shading(PdfPageShadingObject<'a>)

A page object containing a renderable geometric shape whose color is an arbitrary function of position within the shape.

§

XObjectForm(PdfPageXObjectFormObject<'a>)

A page object containing a content stream that itself may consist of multiple other page objects. When this page object is rendered, it renders all its constituent page objects, effectively serving as a template or stamping object.

Despite the page object name including “form”, this page object type bears no relation to an interactive form containing form fields.

§

Unsupported(PdfPageUnsupportedObject<'a>)

Any External Object (“XObject”) page object type not directly supported by Pdfium.

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.

Enum PdfPageObjectCopy item path

Variants§

Text(PdfPageTextObject<'a>)

Path(PdfPagePathObject<'a>)

Image(PdfPageImageObject<'a>)

Shading(PdfPageShadingObject<'a>)

XObjectForm(PdfPageXObjectFormObject<'a>)

Unsupported(PdfPageUnsupportedObject<'a>)

Implementations§

impl<'a> PdfPageObject<'a>

pub fn object_type(&self) -> PdfPageObjectType

pub fn is_supported(&self) -> bool

pub fn is_unsupported(&self) -> bool

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

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

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

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

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

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

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

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

pub fn as_x_object_form_object(&self) -> Option<&PdfPageXObjectFormObject<'_>>

pub fn as_x_object_form_object_mut( &mut self, ) -> Option<&mut PdfPageXObjectFormObject<'a>>

pub fn transform( &mut self, a: PdfMatrixValue, b: PdfMatrixValue, c: PdfMatrixValue, d: PdfMatrixValue, e: PdfMatrixValue, f: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn apply_matrix(&mut self, matrix: PdfMatrix) -> Result<(), PdfiumError>

pub fn reset_matrix(&mut self, matrix: PdfMatrix) -> Result<(), PdfiumError>

pub fn reset_matrix_to_identity(&mut self) -> Result<(), PdfiumError>

pub fn translate( &mut self, delta_x: PdfPoints, delta_y: PdfPoints, ) -> Result<(), PdfiumError>

pub fn scale( &mut self, horizontal_scale_factor: PdfMatrixValue, vertical_scale_factor: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn flip_horizontally(&mut self) -> Result<(), PdfiumError>

pub fn flip_vertically(&mut self) -> Result<(), PdfiumError>

pub fn reflect(&mut self) -> Result<(), PdfiumError>

pub fn rotate_counter_clockwise_degrees( &mut self, degrees: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn rotate_clockwise_degrees( &mut self, degrees: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn rotate_counter_clockwise_radians( &mut self, radians: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn rotate_clockwise_radians( &mut self, radians: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn skew_degrees( &mut self, x_axis_skew: PdfMatrixValue, y_axis_skew: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn skew_radians( &mut self, x_axis_skew: PdfMatrixValue, y_axis_skew: PdfMatrixValue, ) -> Result<(), PdfiumError>

pub fn matrix(&self) -> Result<PdfMatrix, PdfiumError>

pub fn get_translation(&self) -> (PdfPoints, PdfPoints)

pub fn get_horizontal_translation(&self) -> PdfPoints

pub fn get_vertical_translation(&self) -> PdfPoints

pub fn get_scale(&self) -> (PdfMatrixValue, PdfMatrixValue)

pub fn get_horizontal_scale(&self) -> PdfMatrixValue

pub fn get_vertical_scale(&self) -> PdfMatrixValue

pub fn get_rotation_counter_clockwise_degrees(&self) -> PdfMatrixValue

pub fn get_rotation_clockwise_degrees(&self) -> PdfMatrixValue

pub fn get_rotation_counter_clockwise_radians(&self) -> PdfMatrixValue

pub fn get_rotation_clockwise_radians(&self) -> PdfMatrixValue

pub fn get_skew_degrees(&self) -> (PdfMatrixValue, PdfMatrixValue)

pub fn get_x_axis_skew_degrees(&self) -> PdfMatrixValue

pub fn get_y_axis_skew_degrees(&self) -> PdfMatrixValue

pub fn get_skew_radians(&self) -> (PdfMatrixValue, PdfMatrixValue)

pub fn get_x_axis_skew_radians(&self) -> PdfMatrixValue

pub fn get_y_axis_skew_radians(&self) -> PdfMatrixValue

Trait Implementations§

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

fn drop(&mut self)

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

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

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

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

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

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

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

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

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

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

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

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

Auto Trait Implementations§

impl<'a> Freeze for PdfPageObject<'a>

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§

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

fn type_id(&self) -> TypeId

Enum PdfPageObject

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>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<'a, T> PdfPageObjectCommon<'a> for T
where T: PdfPageObjectPrivate<'a>,

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

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