25 releases

0.9.0 May 8, 2024
0.8.0 Mar 24, 2023
0.7.5 Jan 15, 2023
0.7.3 May 21, 2020
0.1.2 Dec 26, 2016

#51 in Command-line interface

Download history 27562/week @ 2024-08-06 28058/week @ 2024-08-13 28809/week @ 2024-08-20 33993/week @ 2024-08-27 31391/week @ 2024-09-03 29036/week @ 2024-09-10 27371/week @ 2024-09-17 32391/week @ 2024-09-24 30741/week @ 2024-10-01 27704/week @ 2024-10-08 26887/week @ 2024-10-15 25331/week @ 2024-10-22 28934/week @ 2024-10-29 29090/week @ 2024-11-05 35675/week @ 2024-11-12 29393/week @ 2024-11-19

128,143 downloads per month
Used in 190 crates (13 directly)

WTFPL license

120KB
3K SLoC

terminfo

Crates.io Crates.io WTFPL Build Status

Terminal capabilities with type-safe getters.

Documentation

Example

use std::io;
use terminfo::{capability as cap, Database};

fn main() {
	let info = Database::from_env().unwrap();

	if let Some(cap::MaxColors(n)) = info.get::<cap::MaxColors>() {
		println!("The terminal supports {} colors.", n);
	} else {
		println!("The terminal does not support colors, what year is this?");
	}

	if let Some(flash) = info.get::<cap::FlashScreen>() {
		flash.expand().to(io::stdout()).unwrap();
	} else {
		println!("FLASH GORDON!");
	}

	info.get::<cap::SetAForeground>().unwrap().expand().color(2).to(io::stdout()).unwrap();
	info.get::<cap::SetABackground>().unwrap().expand().color(4).to(io::stdout()).unwrap();
	println!("SUP");
	info.get::<cap::ExitAttributeMode>().unwrap().expand().to(io::stdout()).unwrap();
}

Packaging and Distributing

For all terminals but windows consoles, this library depends on a non-hashed (for now) terminfo database being present. For example, on Debian derivitives, you should depend on ncurses-term; on Arch Linux, you depend on ncurses; and on MinGW, you should depend on mingw32-terminfo.

Unfortunately, if you're using a non-windows console on Windows (e.g. MinGW, Cygwin, Git Bash), you'll need to set the TERMINFO environment variable to point to the directory containing the terminfo database.

Dependencies

~1MB
~22K SLoC