Struct PtySize

pub struct PtySize {
    pub rows: u16,
    pub cols: u16,
    pub pixel_width: u16,
    pub pixel_height: u16,
}

PTY character-grid and optional pixel dimensions.

Self::new guarantees at least one row and column. Public fields and deserialization bypass that invariant; portable conversion clamps them again. Pixel values are passed through exactly, with zero conventionally meaning unavailable/unspecified rather than one pixel.

Examples

use ailloli_ui_terminal_pty::PtySize;
assert_eq!(PtySize::new(24, 80, 800, 600).cols, 80);
assert_eq!(PtySize::new(0, 0, 0, 0).rows, 1);

Fields

rows: u16

Character-cell rows; constructor-valid range is 1..=u16::MAX.

cols: u16

Character-cell columns; constructor-valid range is 1..=u16::MAX.

pixel_width: u16

Total pixel width, or zero when unspecified.

pixel_height: u16

Total pixel height, or zero when unspecified.

Implementations

impl PtySize

pub const fn new( rows: u16, cols: u16, pixel_width: u16, pixel_height: u16, ) -> Self

Creates dimensions, independently replacing zero rows/columns with one.

Pixel dimensions, including zero, are unchanged.

Examples

use ailloli_ui_terminal_pty::PtySize;
let size = PtySize::new(0, 0, 20, 30);
assert_eq!((size.rows, size.cols, size.pixel_width, size.pixel_height), (1, 1, 20, 30));

Trait Implementations

impl Clone for PtySize

fn clone(&self) -> PtySize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PtySize

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

Formats the value using the given formatter.

impl Default for PtySize

fn default() -> Self

Returns 24 rows, 80 columns, and unspecified pixel dimensions.

Examples

use ailloli_ui_terminal_pty::PtySize;
assert_eq!(PtySize::default(), PtySize::new(24, 80, 0, 0));

impl<'de> Deserialize<'de> for PtySize

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PtySize

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

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 PtySize

impl Eq for PtySize

impl StructuralPartialEq for PtySize