Enum TerminfoResolution

pub enum TerminfoResolution {
    Dynamic,
    None,
    Static(String),
}

Defines terminfo database resolution semantics.

Python links against libraries like readline, libedit, and ncurses which need to utilize a terminfo database (a set of files defining terminals and their capabilities) in order to work properly.

The absolute path to the terminfo database is typically compiled into these libraries at build time. If the compiled path on the building machine doesn’t match the path on the runtime machine, these libraries cannot find the terminfo database and terminal interactions won’t work correctly because these libraries don’t know how to resolve terminal features. This can result in quirks like the backspace key not working in prompts.

The pyembed Rust crate is able to point libraries at a terminfo database at runtime, overriding the compiled-in default path. This enum is used to control that behavior.

Serialization type: string.

Variants

Dynamic

Resolve terminfo database using appropriate behavior for current OS.

We will look for the terminfo database in paths that are common for the current OS / distribution. The terminfo database is present in most systems (except the most barebones containers or sandboxes) and this method is usually successfully in locating the terminfo database.

Serialized value: dynamic

None

Do not attempt to resolve the terminfo database. Basically a no-op.

This is what should be used for applications that don’t interact with the terminal. Using this option will prevent some I/O syscalls that would be incurred by dynamic.

Serialized value: none

Static(String)

Use a specified string as the TERMINFO_DIRS value.

Serialized value: static:<path>

e.g. static:/usr/share/terminfo.

Trait Implementations

impl Clone for TerminfoResolution

fn clone(&self) -> TerminfoResolution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminfoResolution

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

Formats the value using the given formatter.

impl PartialEq for TerminfoResolution

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ToString for TerminfoResolution

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&str> for TerminfoResolution

type Error = String

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<TerminfoResolution, <TerminfoResolution as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for TerminfoResolution

type Error = String

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<TerminfoResolution, <TerminfoResolution as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for TerminfoResolution

impl StructuralPartialEq for TerminfoResolution