Struct terminfo::Database

pub struct Database { /* fields omitted */ }

A capability database.

Implementations

impl Database

pub fn new() -> Builder

Create a new empty database.

pub fn from_env() -> Result<Self>

Load a database from the current environment.

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.

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

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 Eq for Database

impl<'a> Into<Database> for Database<'a>

fn into(self) -> Database

Performs the conversion.

impl PartialEq<Database> 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: &Database) -> bool

This method tests for !=.

impl StructuralEq for Database

impl StructuralPartialEq for Database