TerminalType

Enum TerminalType 

Source
pub enum TerminalType {
    WindowsTerminal,
    Wsl,
    WindowsConsole,
    MacOsTerminal,
    LinuxNative,
    Unknown,
}
Expand description

Terminal type detection for viewport handling

Different terminals report their dimensions differently:

  • Some report the visible viewport size (what the user sees)
  • Others report the buffer size (which can be larger, enabling scrollback)

This enum categorizes terminals based on their reporting behavior.

Variants§

§

WindowsTerminal

Windows Terminal - reports viewport size correctly

§

Wsl

WSL (Windows Subsystem for Linux) - may report buffer size

§

WindowsConsole

PowerShell / cmd - reports buffer size (not viewport)

§

MacOsTerminal

macOS Terminal.app

§

LinuxNative

Ubuntu native terminal (gnome-terminal, etc.)

§

Unknown

Unknown terminal - use conservative defaults

Implementations§

Source§

impl TerminalType

Source

pub fn detect() -> Self

Detect the terminal type from environment variables

Uses environment variables to identify the terminal emulator:

  • WT_SESSION: Windows Terminal
  • WSL_DISTRO_NAME: WSL environment
  • TERM_PROGRAM: macOS Terminal.app or other
  • Platform detection for fallback
Source

pub const fn viewport_height_offset(self, reported_height: u16) -> u16

Calculate viewport height offset based on terminal type

Returns the number of rows to subtract from the reported terminal size to get the actual visible viewport. This compensates for terminals that report buffer size instead of viewport size.

§Arguments
  • reported_height - The height reported by the terminal
§Returns

The number of rows to subtract to get the visible viewport height

Source

pub const fn name(self) -> &'static str

Get a human-readable name for this terminal type

Trait Implementations§

Source§

impl Clone for TerminalType

Source§

fn clone(&self) -> TerminalType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalType

Source§

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

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

impl PartialEq for TerminalType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Copy for TerminalType

Source§

impl Eq for TerminalType

Source§

impl StructuralPartialEq for TerminalType

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more