4 releases

new 0.7.3 May 21, 2025
0.7.0 Jun 26, 2024
0.1.1 Oct 2, 2022
0.1.0 Aug 9, 2022

#508 in Command-line interface

Download history 133/week @ 2025-01-31 205/week @ 2025-02-07 158/week @ 2025-02-14 135/week @ 2025-02-21 131/week @ 2025-02-28 57/week @ 2025-03-07 125/week @ 2025-03-14 143/week @ 2025-03-21 161/week @ 2025-03-28 227/week @ 2025-04-04 81/week @ 2025-04-11 72/week @ 2025-04-18 64/week @ 2025-04-25 233/week @ 2025-05-02 114/week @ 2025-05-09 145/week @ 2025-05-16

562 downloads per month
Used in 3 crates

MIT license

135KB
3.5K SLoC

This crate parses a terminal byte stream and provides an in-memory representation of the rendered contents.

Overview

This is essentially the terminal parser component of a graphical terminal emulator pulled out into a separate crate. Although you can use this crate to build a graphical terminal emulator, it also contains functionality necessary for implementing terminal applications that want to run other terminal applications - programs like screen or tmux for example.

Synopsis

let mut parser = vt100::Parser::new(24, 80, 0);

let screen = parser.screen().clone();
parser.process(b"this text is \x1b[31mRED\x1b[m");
assert_eq!(
    parser.screen().cell(0, 13).unwrap().fgcolor(),
    vt100::Color::Idx(1),
);

let screen = parser.screen().clone();
parser.process(b"\x1b[3D\x1b[32mGREEN");
assert_eq!(
    parser.screen().contents_formatted(),
    &b"\x1b[?25h\x1b[m\x1b[H\x1b[Jthis text is \x1b[32mGREEN"[..],
);
assert_eq!(
    parser.screen().contents_diff(&screen),
    &b"\x1b[1;14H\x1b[32mGREEN"[..],
);

Dependencies

~22–30MB
~525K SLoC