24 releases (12 breaking)

0.13.0 Nov 17, 2023
0.12.0 Sep 26, 2023
0.11.1 May 23, 2023
0.11.0 Jul 20, 2022
0.1.2 Sep 19, 2016

#90 in Parser implementations

Download history 94497/week @ 2023-11-24 102272/week @ 2023-12-01 99396/week @ 2023-12-08 89870/week @ 2023-12-15 60039/week @ 2023-12-22 75003/week @ 2023-12-29 98278/week @ 2024-01-05 110330/week @ 2024-01-12 124202/week @ 2024-01-19 123785/week @ 2024-01-26 124076/week @ 2024-02-02 125685/week @ 2024-02-09 106424/week @ 2024-02-16 101625/week @ 2024-02-23 112862/week @ 2024-03-01 57970/week @ 2024-03-08

398,645 downloads per month
Used in 628 crates (40 directly)

Apache-2.0 OR MIT

145KB
3K SLoC

vte

Build Status Crates.io Version

Parser for implementing virtual terminal emulators in Rust.

The parser is implemented according to Paul Williams' ANSI parser state machine. The state machine doesn't assign meaning to the parsed data and is thus not itself sufficient for writing a terminal emulator. Instead, it is expected that an implementation of the Perform trait which does something useful with the parsed data. The Parser handles the book keeping, and the Perform gets to simply handle actions.

See the docs for more info.


lib.rs:

Parser for implementing virtual terminal emulators

Parser is implemented according to Paul Williams' ANSI parser state machine. The state machine doesn't assign meaning to the parsed data and is thus not itself sufficient for writing a terminal emulator. Instead, it is expected that an implementation of Perform is provided which does something useful with the parsed data. The Parser handles the book keeping, and the Perform gets to simply handle actions.

Examples

For an example of using the Parser please see the examples folder. The example included there simply logs all the actions Perform does. One quick thing to see it in action is to pipe vim into it

cargo build --release --example parselog
vim | target/release/examples/parselog

Just type :q to exit.

Differences from original state machine description

  • UTF-8 Support for Input
  • OSC Strings can be terminated by 0x07
  • Only supports 7-bit codes. Some 8-bit codes are still supported, but they no longer work in all states.

Dependencies

~20–325KB