Skip to main content

TerminalCapabilities

Struct TerminalCapabilities 

Source
pub struct TerminalCapabilities {
    pub color_support: ColorSupport,
    pub bracketed_paste: bool,
    pub mouse: bool,
    pub cursor_style: bool,
}
Expand description

Terminal capabilities that influence how MinUI should render.

Fields§

§color_support: ColorSupport

Color fidelity supported by the terminal.

§bracketed_paste: bool

Whether bracketed paste mode is expected to work.

Note: MinUI enables bracketed paste when initializing TerminalWindow. This flag is purely informational for apps that want to display/adjust UI.

§mouse: bool

Whether mouse capture/reporting is expected to work.

Note: MinUI enables mouse capture when initializing TerminalWindow. This flag is informational, as terminals can still vary.

§cursor_style: bool

Whether changing the cursor style (block/bar/underline) is likely supported.

MinUI does not currently expose cursor styling as a stable public API.

Implementations§

Source§

impl TerminalCapabilities

Source

pub fn detect() -> Self

Best-effort autodetection using environment variables.

This intentionally avoids heavy dependencies and terminfo parsing.

Heuristics:

  • COLORTERM=truecolor or COLORTERM=24bit => Truecolor
  • TERM contains -truecolor => Truecolor
  • TERM contains 256color => Ansi256
  • otherwise => Ansi16

Notes:

  • Many terminals do support truecolor even when TERM doesn’t advertise it.
  • Remote shells and tmux/screen can mask capabilities unless configured.
Source

pub fn downgrade_pair(self, pair: ColorPair) -> ColorPair

Returns a copy of pair with colors downgraded to this terminal’s capabilities.

This is the main “policy hook” for MinUI rendering: widgets/apps can request rich colors, and MinUI will degrade to what the terminal can likely display.

Source

pub fn downgrade_color(self, c: Color) -> Color

Downgrade a single Color to match self.color_support.

Rules:

  • Reset/Transparent are preserved
  • Named ANSI colors are preserved
  • AnsiValue(n) is preserved unless target is Ansi16 (then approximated)
  • Rgb{..} is preserved only for Truecolor; otherwise approximated

Trait Implementations§

Source§

impl Clone for TerminalCapabilities

Source§

fn clone(&self) -> TerminalCapabilities

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TerminalCapabilities

Source§

impl Debug for TerminalCapabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TerminalCapabilities

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for TerminalCapabilities

Source§

impl PartialEq for TerminalCapabilities

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for TerminalCapabilities

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.