rustty/lib.rs
1#![doc(html_root_url = "http://cpjreynolds.github.io/rustty/rustty/index.html")]
2
3//! # Rustty
4//!
5//! Rustty is a terminal UI library that provides a simple, concise abstraction over an
6//! underlying terminal device.
7//!
8//! Rustty is based on the concepts of cells and events. A terminal display is an array of cells,
9//! each holding a character and a set of foreground and background styles. Events are how a
10//! terminal communicates changes in its state; events are received from a terminal, processed, and
11//! pushed onto an input stream to be read and responded to.
12//!
13//! Futher reading on the concepts behind Rustty can be found in the
14//! [README](https://github.com/cpjreynolds/rustty/blob/master/README.md)
15
16extern crate term;
17extern crate libc;
18extern crate gag;
19
20mod core;
21pub mod ui;
22
23pub use core::terminal::Terminal;
24pub use core::cellbuffer::{Cell, Color, Attr, CellAccessor};
25pub use core::position::{Pos, Size, HasSize, HasPosition};
26pub use core::input::Event;