Struct Frame 

pub struct Frame {
    pub width: u16,
    pub height: u16,
    pub cells: Vec<Cell>,
    pub cursor: Option<(u16, u16)>,
    pub rows: Vec<RowInfo>,
    pub roles: Vec<String>,
}

A rendered screen: height rows of width cells, and where the caret is (if visible).

Fields

width: u16

height: u16

cells: Vec<Cell>

cursor: Option<(u16, u16)>

rows: Vec<RowInfo>

One per row: what it shows.

roles: Vec<String>

The names of the Role::Named roles, by index.

Implementations

impl Frame

pub fn role_name(&self, role: Role) -> &str

The name of a role: a built-in role’s wire name, or the name a host gave it.

pub fn cell(&self, x: u16, y: u16) -> &Cell

pub fn to_text(&self) -> String

The rows as plain text, trailing spaces trimmed.

pub fn to_ansi(&self) -> String

The rows with ANSI styling: the selection in reverse video, the status bar highlighted, and the caret as an underlined reverse cell (a snapshot has no terminal cursor).

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

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 Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame