aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
blob: 30544034fd5de2cd6905261381aff0fcc4eaa1b0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
//! 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. This can be used to not only
//! build graphical terminal emulators, but also many other types of
//! applications that need to interact with a terminal data stream directly,
//! such as terminal multiplexers or terminal recording applications.
//!
//! # Synopsis
//!
//! ```
//! let mut screen = vt100::Screen::new(24, 80);
//! screen.process(b"this text is \x1b[31mRED\x1b[m");
//! ```

#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
#![allow(clippy::missing_const_for_fn)]
#![allow(clippy::single_match)]

mod attrs;
mod cell;
mod grid;
mod row;
mod screen;
mod unicode;

pub use attrs::Color;
pub use cell::Cell;
pub use screen::{MouseProtocolEncoding, MouseProtocolMode, Screen};