Skip to main content

RenderNode

Enum RenderNode 

Source
pub enum RenderNode {
    Empty,
    TextLines {
        area: Rect,
        style: TextStyle,
        lines: Vec<String>,
        paragraph_end: Vec<bool>,
        line_height_pt: f32,
        url: Option<String>,
        anchor: Option<String>,
        link_to: Option<String>,
        outline_level: Option<u8>,
    },
    RichTextLines {
        area: Rect,
        align: Align,
        lines: Vec<RichLine>,
    },
    Rect {
        area: Rect,
        background: Option<Color>,
        border: Option<Border>,
        corner_radius: f32,
    },
    Line {
        x1: f32,
        y1: f32,
        x2: f32,
        y2: f32,
        thickness: f32,
        color: Color,
    },
    Image {
        area: Rect,
        bytes: Arc<[u8]>,
        format: ImageFormat,
        width_px: u32,
        height_px: u32,
        components: u8,
        alt: Option<String>,
    },
    Group {
        area: Rect,
        clip: bool,
        background: Option<Color>,
        border: Option<Border>,
        corner_radius: f32,
        children: Vec<RenderNode>,
    },
    Tagged {
        role: StructRole,
        inner: Box<RenderNode>,
    },
}
Expand description

Positioned, resolved layout output ready for the facade to translate into lightweight-pdf-writer content-stream operations. Never seen by lightweight-pdf-writer directly (plan/00a-contracts-and-artifacts.md point 3).

Variants§

§

Empty

§

TextLines

Already-wrapped lines, one per output line, top-aligned within area.

Fields

§area: Rect
§lines: Vec<String>
§paragraph_end: Vec<bool>

Same length as lines: true for the last line of its source paragraph. Only consulted when style.align == Align::Justify (that line stays left-aligned instead of being stretched); every other alignment ignores it.

§line_height_pt: f32
§anchor: Option<String>
§link_to: Option<String>
§outline_level: Option<u8>

Text::outline_level — the PDF bookmark tree is built from these, in document order, once pagination is final.

§

RichTextLines

Text::rich(..) (issue #11) — the multi-style counterpart to TextLines. Deliberately a separate variant rather than a shape change to TextLines: every existing TextLines consumer (facade rendering, font-collection, outline/anchor collection) keeps working unmodified for plain Text, and this variant just isn’t handled by any of the outline/anchor/link machinery yet (rich text doesn’t support those in V1, see Text::spans’ doc comment).

Fields

§area: Rect
§align: Align
§lines: Vec<RichLine>
§

Rect

Fields

§area: Rect
§background: Option<Color>
§border: Option<Border>
§corner_radius: f32
§

Line

Fields

§x1: f32
§y1: f32
§x2: f32
§y2: f32
§thickness: f32
§color: Color
§

Image

A validated JPEG/PNG placed at its final, Contain-fit size. bytes are the original file bytes (facade decides how to embed them — JPEG passes through as DCTDecode, PNG gets decoded once here to split out the alpha channel as a SMask).

Fields

§area: Rect
§bytes: Arc<[u8]>
§width_px: u32
§height_px: u32
§components: u8
§alt: Option<String>

Image::alt (issue #27) — carried through layout so the facade can both write /Alt and warn when it’s missing.

§

Group

A container’s own box: clipped (Grundprinzip 4), optionally painted with a background/border, holding its children.

Fields

§area: Rect
§clip: bool
§background: Option<Color>
§border: Option<Border>
§corner_radius: f32
§children: Vec<RenderNode>
§

Tagged

Wraps inner with a structure-tree role (issue #27) — a wrapper variant rather than a field on every other variant, so tagging support doesn’t require touching every RenderNode construction site in this crate. Attached at Element::layout’s dispatch (see layoutable::mod) plus, for Table/List/TableOfContents, inside their own layout code where row/cell/item structure is known.

Fields

Implementations§

Source§

impl RenderNode

Source

pub fn clipped(area: Rect, inner: RenderNode) -> RenderNode

Wraps self in a clipping group bound to area — the render-pass safety net required from every element, not only containers (Grundprinzip 4/6).

Source

pub fn height(&self) -> f32

Source

pub fn tagged(role: StructRole, inner: RenderNode) -> RenderNode

Wraps self with a structure-tree role (issue #27) — see RenderNode::Tagged’s doc comment.

Trait Implementations§

Source§

impl Clone for RenderNode

Source§

fn clone(&self) -> RenderNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RenderNode

Source§

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

Formats the value using the given formatter. Read more

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 = !

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.