Struct terminfo::Database

pub struct Database { /* private fields */ }

A capability database.

Implementations

impl Database

pub fn new() -> Builder

Create a database builder for constucting a database.

pub fn from_env() -> Result<Self>

Load a database from the current environment.

Examples found in repository

examples/set_attributes.rs (line 5)

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

	if let Some(set_attributes) = info.get::<cap::SetAttributes>() {
		let clear = info.get::<cap::ExitAttributeMode>().unwrap();

		set_attributes.expand().bold(true).underline(true).to(io::stdout()).unwrap();

		println!("bold and underline");

		clear.expand().to(io::stdout()).unwrap();
	} else {
		println!("The terminal does not support mass-setting attributes");
	}
}

examples/simple.rs (line 5)

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();
}

pub fn from_name<N: AsRef<str>>(name: N) -> Result<Self>

Load a database for the given name.

pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self>

Load a database from the given path.

Examples found in repository

examples/parse.rs (line 18)

fn main() {
	println!("{:?}", terminfo::Database::from_path(env::args().nth(1).expect("no file given")));
}

pub fn from_buffer<T: AsRef<[u8]>>(buffer: T) -> Result<Self>

Load a database from a buffer.

pub fn name(&self) -> &str

The terminal name.

pub fn aliases(&self) -> &[String]

The terminal aliases.

pub fn description(&self) -> &str

The terminal description.

pub fn get<'a, C: Capability<'a>>(&'a self) -> Option<C>

Get a capability.

Example

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

let info        = Database::from_env().unwrap();
let colors: i32 = info.get::<cap::MaxColors>().unwrap().into();

Examples found in repository

examples/set_attributes.rs (line 7)

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

	if let Some(set_attributes) = info.get::<cap::SetAttributes>() {
		let clear = info.get::<cap::ExitAttributeMode>().unwrap();

		set_attributes.expand().bold(true).underline(true).to(io::stdout()).unwrap();

		println!("bold and underline");

		clear.expand().to(io::stdout()).unwrap();
	} else {
		println!("The terminal does not support mass-setting attributes");
	}
}

examples/simple.rs (line 7)

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();
}

pub fn raw<S: AsRef<str>>(&self, name: S) -> Option<&Value>

Get a capability by name.

Note

This interface only makes sense for extended capabilities since they don’t have standardized types.

Example

use terminfo::Database;

let info      = Database::from_env().unwrap();
let truecolor = info.raw("Tc").is_some();

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Database

fn eq(&self, other: &Database) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Database

impl StructuralPartialEq for Database