Struct TerminalSize 

pub struct TerminalSize {
    pub columns: u16,
    pub rows: u16,
    pub pixels: Option<PixelSize>,
    pub cell: Option<PixelSize>,
}

The size of a terminal.

Fields

columns: u16

The width of the terminal, in characters aka columns.

rows: u16

The height of the terminal, in lines.

pixels: Option<PixelSize>

The size in pixels, if available.

cell: Option<PixelSize>

The size of once cell, if available.

Implementations

impl TerminalSize

pub fn from_env() -> Option<Self>

Get terminal size from $COLUMNS and $LINES.

Do not assume any knowledge about window size.

pub fn from_terminal() -> Option<Self>

Detect the terminal size by querying the underlying terminal.

On unix this issues a ioctl to the controlling terminal.

On Windows this uses the terminal_size crate which does some magic windows API calls.

pub fn detect() -> Option<Self>

Detect the terminal size.

Get the terminal size from the underlying TTY, and fallback to $COLUMNS and $LINES.

pub fn with_max_columns(&self, max_columns: u16) -> Self

Shrink the terminal size to the given amount of maximum columns.

Also shrinks the pixel size accordingly.

Trait Implementations

impl Clone for TerminalSize

fn clone(&self) -> TerminalSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalSize

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

Formats the value using the given formatter.

impl Default for TerminalSize

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TerminalSize

fn eq(&self, other: &TerminalSize) -> 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 Copy for TerminalSize

impl StructuralPartialEq for TerminalSize