Lines of Code

Unified API for different TUI libraries.

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:

1) These libraries differ in the API.

A smart choice would be to create an adapter layer to one of these libraries so that you wont have an direct dependency 
and you won't need to update your code base when you want to switch or upgrade. Creating those adapters is boring (mapping types).
Fortunately, this library does that for you. Some examples of those mappings can be found in those libraries: ([cursive][cursive], [tui][tui], [termimad][termimad], ...).

2) These libraries can be complex for beginners.

This library offers a very thin and simple abstraction to make it somewhat easier for the user.
This is achieved by hiding the implementation details. 
Implementation details cover raw mode, write to buffer, batch operations.
Yet an other abstraction :).

3) Libraries differ in how they work.

Like cursor 0 or 1 based, cleaning resources, event handling, performing actions.

This libary is still quite young. You can expect complications. If you experience problems, feel free to make an issue. I'd fix it as soon as possible.

Features
Implemented Backends
Getting Started
Other Resources
Contributing

Features

Batching multiple terminal commands before executing (flush).
Complete control over the underlying buffer.
Locking the terminal for a certain duration.
Backend of your choice.

Implemented Backends

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.

like toml [dependencies.terminal] version = "0.2" features = ["crossterm-backend"]

In the backend-specification document you will find each backend and it's benefits described.

Yet to Implement

ncurses

Getting Started

Click to show Cargo.toml.

toml [dependencies] terminal = "0.2" features = ["your_backend_choice"]

```rust 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(())

} ```

Other Resources

Contributing

I would appreciate any kind of contribution. Before you do, please, read the Contributing guidelines.

Authors

Timon Post - Project Owner & creator

License

This project, terminal are licensed under the MIT License - see the LICENSE file for details.