]> git.proxmox.com Git - rustc.git/blob - vendor/vte/README.md
New upstream version 1.73.0+dfsg1
[rustc.git] / vendor / vte / README.md
1 vte
2 ===
3
4 [![Build Status](https://travis-ci.org/alacritty/vte.svg?branch=master)](https://travis-ci.org/alacritty/vte)
5 [![Crates.io Version](https://img.shields.io/crates/v/vte.svg)](https://crates.io/crates/vte/)
6
7 Parser for implementing virtual terminal emulators in Rust.
8
9 The parser is implemented according to [Paul Williams' ANSI parser state
10 machine]. The state machine doesn't assign meaning to the parsed data and is
11 thus not itself sufficient for writing a terminal emulator. Instead, it is
12 expected that an implementation of the `Perform` trait which does something
13 useful with the parsed data. The `Parser` handles the book keeping, and the
14 `Perform` gets to simply handle actions.
15
16 See the [docs] for more info.
17
18 [Paul Williams' ANSI parser state machine]: https://vt100.net/emu/dec_ansi_parser
19 [docs]: https://docs.rs/crate/vte/