Termular is a toolkit for the development of terminal user interfaces that aims to increase the readability and expressiveness of the code. Both goals are achieved by exposing a lazy fluent interface, the latter brings another benefit: greater control over buffers flushing.
use termular::nio::ReadNonblock;
use termular::printer::{Color, FontWeight, Styled};
use termular::screen::Buffer;
use termular::{Mode, Term};
use std::{io, time::Duration};
fn main() -> io::Result<()> {
let (stdout, stderr) = (io::stdout(), io::stderr());
let mut term = Term::open(stdout.lock(), stderr.lock())?;
let center = term.size()? / 2;
term.flow()
.set_mode(Mode::Raw)
.screen()
.set_buffer(Buffer::Alternate)
.clear()
.cursor()
.hide()
.set_position(center - [5, 4])
.printer()
.print(
"Hello world"
.with_foreground(Color::Green)
.with_weight(FontWeight::Bold),
)
.cursor()
.set_position(center - [2, 2])
.printer()
.print("press")
.cursor()
.set_position(center - [5, 1])
.printer()
.print("- <SPACE> -")
.cursor()
.set_position(center - [3, 0])
.printer()
.print("to exit")
.flush()?;
term.stdin_mut()
.read_timeout_until(b' ', &mut Vec::new(), Duration::from_secs(30))
.map(|_| ())
}Check out more examples in this folder.
There are a lot of amazing crates around that try to perform the same task (or a very similar one) as Termular.
Here is a list, in no particular order, of those from which I drew inspiration:
Termular relies on the deadline_api feature that has not been stabilized yet,
so nightly channel is required in order to build the crate.
Currently, only UNIX systems are supported, and very few terminals have been tested.
Termular is in a early development stage so expect it to break compatibility at any time.
Consider this project unstable and not backward compatible.
Internally, some unsafe blocks are used, mainly to interface with the C language.
MIT