Struct Rendered 

pub struct Rendered {
    pub lines: Vec<String>,
    pub cursor: Option<(usize, usize)>,
    pub images: Vec<ImageCommand>,
}

The output of a component’s render call.

Contains the text lines to display, an optional cursor position, and any terminal image commands that should be emitted.

Fields

lines: Vec<String>

Lines of text, each guaranteed to fit within the requested width.

cursor: Option<(usize, usize)>

Optional cursor position as (row, col) in screen coordinates.

images: Vec<ImageCommand>

Terminal image commands (Kitty / iTerm2 protocols) to emit.

Implementations

impl Rendered

pub fn empty() -> Self

Create an empty rendered frame with no lines, cursor, or images.

pub fn blit_onto(&self, target: &mut Rendered, row: u16, col: u16)

Composite this rendered content onto a target at the given offset.

Lines are overwritten starting at row / col. The cursor and image commands are translated and appended to the target.

pub fn blit_into_rect(&self, target: &mut Rendered, rect: Rect)

Composite this rendered content into a target at the given rect.

Lines are clipped to rect.height. Each line is inserted at rect.x and truncated to rect.width. The cursor and images are translated.

Trait Implementations

impl Clone for Rendered

fn clone(&self) -> Rendered

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rendered

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

Formats the value using the given formatter.

impl PartialEq for Rendered

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Rendered