Struct TermInfo

pub struct TermInfo {
    pub name: String,
    pub description: String,
    pub aliases: Vec<String>,
    /* private fields */
}

Terminfo database information

Fields

name: String

description: String

aliases: Vec<String>

Implementations

impl TermInfo

pub fn parse<R: Read>(reader: R) -> Result<TermInfo, Error>

Create terminfo database by parse byte-array directly

impl TermInfo

pub fn raw_string_cap(&self, cap: StringCapability) -> Option<&[u8]>

Returns the string value for the capability

Arguments

• cap - string capability

Example

use termini::TermInfo;
use termini::StringCapability;

if let Ok(info) = TermInfo::from_env() {
    println!("{:?}", info.raw_string_cap(StringCapability::Bell));
}

pub fn utf8_string_cap(&self, cap: StringCapability) -> Option<&str>

Returns the string value for the capability. If the capability is invalid UTF-8 (ASCII) or doesn’t exists None is returned

Arguments

• cap - string capability

Example

use termini::TermInfo;
use termini::StringCapability;

if let Ok(info) = TermInfo::from_env() {
    println!("{:?}", info.utf8_string_cap(StringCapability::Bell));
}

pub fn number_cap(&self, cap: NumberCapability) -> Option<i32>

Returns the number value for the capability

Arguments

• cap - number capability

Example

use termini::TermInfo;
use termini::NumberCapability;

if let Ok(info) = TermInfo::from_env() {
    println!("{:?}", info.number_cap(NumberCapability::MaxColors));
}

pub fn flag_cap(&self, cap: BoolCapability) -> bool

Returns the bool value for the capability, if the capability is not present, false is returned

Arguments

• cap - bool capability

Example

use termini::TermInfo;
use termini::BoolCapability;

if let Ok(info) = TermInfo::from_env() {
    println!("{:?}", info.flag_cap(BoolCapability::AutoLeftMargin));
}

pub fn extended_cap(&self, name: &str) -> Option<Value<'_>>

pub fn from_env() -> Result<Self, Error>

Create TermInfo database, using TERM environment var.

pub fn from_name(name: &str) -> Result<Self, Error>

Create TermInfo database for the given name

pub fn from_path(file: impl AsRef<Path>) -> Result<TermInfo, Error>

Rad a TermInfo database from a given path

Trait Implementations

impl Debug for TermInfo

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

Formats the value using the given formatter.

impl Default for TermInfo

fn default() -> TermInfo

Returns the “default value” for a type.