Struct vt100::Screen

pub struct Screen { /* fields omitted */ }

Represents the overall terminal state.

Methods

impl Screen

pub fn set_size(&mut self, rows: u16, cols: u16)

Resizes the terminal.

pub fn size(&self) -> (u16, u16)

Returns the current size of the terminal.

The return value will be (rows, cols).

pub fn contents(&self) -> String

Returns the text contents of the terminal.

This will not include any formatting information, and will be in plain text format.

pub fn rows(&self, start: u16, width: u16) -> impl Iterator<Item = String> + '_

Returns the text contents of the terminal by row, restricted to the given subset of columns.

This will not include any formatting information, and will be in plain text format.

Newlines will not be included.

pub fn contents_formatted(&self) -> Vec<u8>

Returns the formatted contents of the terminal.

Formatting information will be included inline as terminal escape codes. The result will be suitable for feeding directly to a raw terminal parser, and will result in the same visual output. Internal terminal modes (such as application keypad mode or alternate screen mode) will not be included here, but modes that affect the visible output (such as hidden cursor mode) will.

pub fn rows_formatted(
    &self,
    start: u16,
    width: u16
) -> impl Iterator<Item = Vec<u8>> + '_

Returns the formatted contents of the terminal by row, restricted to the given subset of columns.

Formatting information will be included inline as terminal escape codes. The result will be suitable for feeding directly to a raw terminal parser, and will result in the same visual output. Internal terminal modes (such as application keypad mode or alternate screen mode) will not be included here.

CRLF at the end of lines will not be included.

pub fn contents_diff(&self, prev: &Self) -> Vec<u8>

Returns a terminal byte stream sufficient to turn the screen described by prev into the screen described by self.

The result of rendering prev.contents_formatted() followed by self.contents_diff(prev) should be equivalent to the result of rendering self.contents_formatted(). This is primarily useful when you already have a terminal parser whose state is described by prev, since the diff will likely require less memory and cause less flickering than redrawing the entire screen contents.

pub fn rows_diff<'a>(
    &'a self,
    prev: &'a Self,
    start: u16,
    width: u16
) -> impl Iterator<Item = Vec<u8>> + 'a

Returns a sequence of terminal byte streams sufficient to turn the subset of each row from prev (as described by start and width) into the corresponding row subset in self.

You must handle the initial row positioning yourself - each row diff expects to start out positioned at the start of that row. Internal terminal modes (such as application keypad mode or alternate screen mode) will not be included here.

pub fn cell(&self, row: u16, col: u16) -> Option<&Cell>

Returns the Cell object at the given location in the terminal, if it exists.

pub fn cursor_position(&self) -> (u16, u16)

Returns the current cursor position of the terminal.

The return value will be (row, col).

pub fn title(&self) -> &str

Returns the terminal's window title.

pub fn icon_name(&self) -> &str

Returns the terminal's icon name.

pub fn check_audible_bell(&mut self) -> bool

Returns whether an audible bell has occurred since the last time this method was called.

pub fn check_visual_bell(&mut self) -> bool

Returns whether an visual bell has occurred since the last time this method was called.

pub fn application_keypad(&self) -> bool

Returns whether the terminal should be in application keypad mode.

pub fn application_cursor(&self) -> bool

Returns whether the terminal should be in application cursor mode.

pub fn hide_cursor(&self) -> bool

Returns whether the terminal should be in hide cursor mode.

pub fn bracketed_paste(&self) -> bool

Returns whether the terminal should be in bracketed paste mode.

pub fn mouse_protocol_mode(&self) -> MouseProtocolMode

Returns the currently active MouseProtocolMode

pub fn mouse_protocol_encoding(&self) -> MouseProtocolEncoding

Returns the currently active MouseProtocolEncoding

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Screen

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

Formats the value using the given formatter.

impl Perform for Screen

fn print(&mut self, c: char)

Draw a character to the screen and update states

fn execute(&mut self, b: u8)

Execute a C0 or C1 control function

fn esc_dispatch(
    &mut self,
    _params: &[i64],
    intermediates: &[u8],
    _ignore: bool,
    b: u8
)

The final character of an escape sequence has arrived.

fn csi_dispatch(
    &mut self,
    params: &[i64],
    intermediates: &[u8],
    _ignore: bool,
    c: char
)

A final character has arrived for a CSI sequence

fn osc_dispatch(&mut self, params: &[&[u8]])

Dispatch an operating system command

fn hook(&mut self, params: &[i64], intermediates: &[u8], _ignore: bool)

Invoked when a final character arrives in first part of device control string

fn put(&mut self, _: u8)

Pass bytes as part of a device control string to the handle chosen in hook. C0 controls will also be passed to the handler.

fn unhook(&mut self)

Called when a device control string is terminated