Struct Size 

pub struct Size { /* private fields */ }

Dimensions of a pseudoconsole, in character cells.

A Size is always valid: both dimensions are non-zero and at most Size::MAX_DIMENSION. Construct one with Size::try_new; Size::default is 80 columns by 24 rows.

Examples

use conpty_oxide::Size;

let size = Size::try_new(80, 24)?;
assert_eq!(size.rows(), 24);
assert_eq!(size.cols(), 80);
assert_eq!(size, Size::default());

Implementations

impl Size

pub const MAX_DIMENSION: u16

Maximum value for either dimension: i16::MAX (32767).

ConPTY’s COORD stores dimensions as i16, so anything larger cannot be represented.

pub const fn try_new(cols: u16, rows: u16) -> Result<Self>

Creates a Size, validating both dimensions.

Errors

Returns an error with crate::ErrorKind::InvalidSize if either dimension is 0 or greater than Size::MAX_DIMENSION.

pub const fn rows(&self) -> u16

Returns the number of rows (screen buffer height).

pub const fn cols(&self) -> u16

Returns the number of columns (screen buffer width).

Trait Implementations

impl Clone for Size

fn clone(&self) -> Size

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Size

impl Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

24 rows by 80 columns, the traditional terminal size.

fn default() -> Self

Returns the “default value” for a type.

impl Display for Size

Formats as <cols>x<rows> — columns first, matching the conventional terminal geometry notation (e.g. the default size displays as 80x24).

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

Formats the value using the given formatter.

impl Eq for Size

impl Hash for Size

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Size

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Size