Struct Term

pub struct Term<W: PtyWriter> { /* private fields */ }

An in-memory terminal emulator.

Implementations

impl<W: PtyWriter> Term<W>

pub fn new(lines: u16, columns: u16, pty_writer: W) -> Self

Create a new emulated terminal with a cell matrix of lines by columns.

pty_writer is used to send output from the emulated terminal in reponse to ANSI requests. Use VoidPtyWriter if you do not need to send responses to status requests.

pub fn process(&mut self, byte: u8)

Process one byte of ANSI-escaped terminal data.

pub fn process_with_callback( &mut self, byte: u8, cb: impl FnMut(&Self, AnsiSignal), )

Process one byte of ANSI-escaped terminal data. Some ANSI signals will trigger callback cb to be called with a reference to the terminal and the signal that triggered the call, right before applying the result of the ANSI signal to the terminal. This allows grabbing a snapshot of the the terminal screen contents before application of the signal.

See also AnsiSignal.

pub fn resize(&mut self, lines: u16, columns: u16)

Resize the terminal screen to the specified dimension.

pub fn current_screen(&self) -> Screen

Get a snapshot of the current terminal screen.