Skip to main content

PageObjectCtx

Struct PageObjectCtx 

Source
pub struct PageObjectCtx<'doc> { /* private fields */ }
Expand description

Immutable context for accessing page objects on a single page.

Obtained via EditDocument::page_objects().

This type exists solely to provide correctly-namespaced ADR-019 T2 aliases for FPDFPage_* object functions, which otherwise collide with the FPDFAnnot_* aliases of the same snake_case name on EditDocument.

§Example

let ctx = doc.page_objects(0);
let count = ctx.count_objects().unwrap();
let bytes = ctx.get_object(0).unwrap();

Implementations§

Source§

impl<'doc> PageObjectCtx<'doc>

Source

pub fn get_object(&self, index: usize) -> Result<Vec<u8>, EditError>

Returns a copy of the raw content bytes for the page object at index.

Each object inserted via EditDocument::insert_page_object() is serialised as a q … Q (graphic-state save/restore) block. This method returns the bytes of the block at position index.

Returns EditError::InvalidObjectIndex if index is out of bounds.

ADR-019 T2 alias for FPDFPage_GetObject. Namespaced here to avoid collision with the FPDFAnnot_GetObject alias on EditDocument.

See also AnnotObjectCtx::get_object() for the annotation side.

Source

pub fn count_objects(&self) -> Result<usize, EditError>

Returns the number of page objects on this page.

ADR-019 T2 alias for FPDFPage_CountObjects.

Auto Trait Implementations§

§

impl<'doc> Freeze for PageObjectCtx<'doc>

§

impl<'doc> !RefUnwindSafe for PageObjectCtx<'doc>

§

impl<'doc> Send for PageObjectCtx<'doc>

§

impl<'doc> Sync for PageObjectCtx<'doc>

§

impl<'doc> Unpin for PageObjectCtx<'doc>

§

impl<'doc> UnsafeUnpin for PageObjectCtx<'doc>

§

impl<'doc> !UnwindSafe for PageObjectCtx<'doc>

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more