This library offers a universal API over various terminal libraries such as termion, crossterm, ncurses, pancurses, and console.
Why would I need this library? Three main reasons:
- Being less dependent on a specific terminal library with certain features.
- Support different features depending on the chosen backend and allow you to change at any given time.
- Hides implementation details (raw mode, write to the buffer, batch operations).
- Hides the differences (cursor 0 or 1 based, cleaning resources, event handling, performing actions. )
- Reduces backend mapping duplication in the ecosystem (cursive, tui, termimad, ...)
This library is still quite young. If you experience problems, feel free to make an issue. I'd fix it as soon as possible.
- Batching multiple terminal commands before executing (flush).
- Complete control over the underlying buffer.
- Locking the terminal for a certain duration.
- Backend of your choice.
- Crossterm (Pure rust and crossplatform)
- Termion (Pure rust for UNIX systems)
- Crosscurses (crossplatform but requires ncurses C dependency (fork pancurses))
Use one of the below feature flags to choose an backend.
| Feature | Description |
|---|---|
crossterm-backend |
crossterm backend will be used. |
termion-backend |
termion backend will be used. |
crosscurses-backend |
crosscurses backend will be used. |
like
[dependencies.terminal]
version = "0.2"
features = ["crossterm-backend"] In the backend-specification document you will find each backend and it's benefits described.
Click to show Cargo.toml.
[dependencies]
terminal = "0.2"
features = ["your_backend_choice"] use terminal::{Action, Clear, error, Retrieved, Value};
use std::io::Write;
pub fn main() -> error::Result<()> {
let mut terminal = terminal::stdout();
// perform an single action.
terminal.act(Action::ClearTerminal(Clear::All))?;
// batch multiple actions.
for i in 0..20 {
terminal.batch(Action::MoveCursorTo(0, i))?;
terminal.write(format!("{}", i).as_bytes());
}
// execute batch.
terminal.flush_batch();
// get an terminal value.
if let Retrieved::TerminalSize(x, y) = terminal.get(Value::TerminalSize)? {
println!("\nx: {}, y: {}", x, y);
}
Ok(())
}I would appreciate any kind of contribution. Before you do, please, read the Contributing guidelines.
- Timon Post - Project Owner & creator
This project, terminal are licensed under the MIT
License - see the LICENSE file for details.