Struct Parser

pub struct Parser<CB: Callbacks = ()> { /* private fields */ }

A parser for terminal output which produces an in-memory representation of the terminal contents.

Implementations

impl Parser

pub fn new(rows: u16, cols: u16, scrollback_len: usize) -> Self

Creates a new terminal parser of the given size and with the given amount of scrollback.

impl<CB: Callbacks> Parser<CB>

pub fn new_with_callbacks( rows: u16, cols: u16, scrollback_len: usize, callbacks: CB, ) -> Self

Creates a new terminal parser of the given size and with the given amount of scrollback. Terminal events will be reported via method calls on the provided Callbacks implementation.

pub fn process(&mut self, bytes: &[u8])

Processes the contents of the given byte string, and updates the in-memory terminal state.

pub fn screen(&self) -> &Screen

Returns a reference to a Screen object containing the terminal state.

pub fn screen_mut(&mut self) -> &mut Screen

Returns a mutable reference to a Screen object containing the terminal state.

pub fn callbacks(&self) -> &CB

Returns a reference to the Callbacks state object passed into the constructor.

pub fn callbacks_mut(&mut self) -> &mut CB

Returns a mutable reference to the Callbacks state object passed into the constructor.

Trait Implementations

impl Default for Parser

fn default() -> Self

Returns a parser with dimensions 80x24 and no scrollback.

impl Write for Parser

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.