Skip to main content

RenderPage

Struct RenderPage 

Source
pub struct RenderPage {
    pub page_number: usize,
    pub commands: Vec<DrawCommand>,
    pub content_commands: Vec<DrawCommand>,
    pub chrome_commands: Vec<DrawCommand>,
    pub overlay_commands: Vec<DrawCommand>,
    pub overlay_items: Vec<OverlayItem>,
    pub annotations: Vec<PageAnnotation>,
    pub metrics: PageMetrics,
}
Expand description

Page represented as backend-agnostic draw commands.

Fields§

§page_number: usize

1-based page number.

§commands: Vec<DrawCommand>

Legacy merged command stream.

This remains for compatibility and is kept in sync with content_commands, chrome_commands, and overlay_commands.

§content_commands: Vec<DrawCommand>

Content-layer draw commands (deterministic pagination output).

§chrome_commands: Vec<DrawCommand>

Chrome-layer draw commands (header/footer/progress and similar).

§overlay_commands: Vec<DrawCommand>

Overlay draw commands attached after content/chrome layout.

§overlay_items: Vec<OverlayItem>

Structured overlay items attached by composer APIs.

§annotations: Vec<PageAnnotation>

Structured non-draw annotations associated with this page.

§metrics: PageMetrics

Per-page metrics for navigation/progress consumers.

Implementations§

Source§

impl RenderPage

Source

pub fn new(page_number: usize) -> Self

Create an empty page.

Source

pub fn push_content_command(&mut self, cmd: DrawCommand)

Push a content-layer command.

Source

pub fn push_chrome_command(&mut self, cmd: DrawCommand)

Push a chrome-layer command.

Source

pub fn push_overlay_command(&mut self, cmd: DrawCommand)

Push an overlay-layer command.

Source

pub fn sync_commands(&mut self)

Rebuild legacy merged commands from split layers.

Source

pub fn page_meta(&self) -> &PageMeta

Backward-compatible accessor alias for page metadata.

Trait Implementations§

Source§

impl Clone for RenderPage

Source§

fn clone(&self) -> RenderPage

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RenderPage

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RenderPage

Source§

fn default() -> RenderPage

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RenderPage

Source§

fn eq(&self, other: &RenderPage) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RenderPage

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.