Struct Frame 

pub struct Frame {
    pub rows: Vec<Row>,
    pub width: usize,
    pub cursor: Option<CursorCoord>,
    pub cursor_visible: bool,
}

The complete live-region render.

A frame is an ordered list of rows representing the current live region: active streaming block, dynamic status, prompt input, accessories, and static status. Frames are diffed and redrawn each tick.

Fields

rows: Vec<Row>

width: usize

cursor: Option<CursorCoord>

cursor_visible: bool

When false, the cursor is hidden (blink off phase).

Implementations

impl Frame

pub fn new(width: usize) -> Self

Create an empty frame at width.

pub fn push(&mut self, row: Row)

Append a row.

pub fn set_cursor(&mut self, cursor: CursorCoord)

Set the cursor coordinate.

pub fn len(&self) -> usize

Number of rows.

pub fn is_empty(&self) -> bool

Whether the frame has no rows.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame