Struct TerminalSize

pub struct TerminalSize {
    pub rows: usize,
    pub cols: usize,
}

Terminal grid dimensions, measured in whole character cells.

Self::new guarantees both values are at least one. Public fields and derived deserialization can bypass that invariant; use Self::clamped before arithmetic/indexing. There is no upper bound.

Examples

use ailloli_ui_terminal_core::TerminalSize;
assert_eq!(TerminalSize::new(24, 80), TerminalSize { rows: 24, cols: 80 });

Fields

rows: usize

Visible row count in cells.

cols: usize

Visible column count in cells.

Implementations

impl TerminalSize

pub const DEFAULT_ROWS: usize = 24usize

Default terminal height: 24 rows.

Examples

use ailloli_ui_terminal_core::TerminalSize;
assert_eq!(TerminalSize::DEFAULT_ROWS, 24);

pub const DEFAULT_COLS: usize = 80usize

Default terminal width: 80 columns.

Examples

use ailloli_ui_terminal_core::TerminalSize;
assert_eq!(TerminalSize::DEFAULT_COLS, 80);

pub const fn new(rows: usize, cols: usize) -> Self

Creates a size, replacing each zero dimension independently with one.

All positive usize values, including usize::MAX, are retained.

Examples

use ailloli_ui_terminal_core::TerminalSize;
assert_eq!(TerminalSize::new(0, 0), TerminalSize { rows: 1, cols: 1 });

pub const fn clamped(self) -> Self

Returns this size with zero dimensions replaced by one.

Examples

use ailloli_ui_terminal_core::TerminalSize;
assert_eq!(TerminalSize { rows: 0, cols: 7 }.clamped(), TerminalSize::new(1, 7));

Trait Implementations

impl Clone for TerminalSize

fn clone(&self) -> TerminalSize

Returns a copy 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<'de> Deserialize<'de> for TerminalSize

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for TerminalSize

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TerminalSize

impl Eq for TerminalSize

impl StructuralPartialEq for TerminalSize