Struct Size 

pub struct Size {
    pub width: u16,
    pub height: u16,
}

A simple size struct for representing dimensions in the terminal.

The width and height are stored as u16 values and represent the number of columns and rows respectively. This is used throughout the layout system to represent dimensions of rectangular areas and other layout elements.

Size can be created from tuples, extracted from rectangular areas, or constructed directly. It’s commonly used in conjunction with Position to define rectangular areas.

Construction

• new - Create a new size from width and height
• default - Create with zero dimensions

Conversion

• from((u16, u16)) - Create from (u16, u16) tuple
• from(Rect) - Create from Rect (uses width and height)
• [into((u16, u16))] - Convert to (u16, u16) tuple

Computation

• area - Compute the total number of cells covered by the size

Examples

use ratatui_core::layout::{Rect, Size};

let size = Size::new(80, 24);
assert_eq!(size.area(), 1920);
let size = Size::from((80, 24));
let size = Size::from(Rect::new(0, 0, 80, 24));
assert_eq!(size.area(), 1920);

For comprehensive layout documentation and examples, see the layout module.

Fields

width: u16

The width in columns

height: u16

The height in rows

Implementations

impl Size

pub const ZERO: Size

A zero sized Size

pub const MIN: Size = Self::ZERO

The minimum possible Size

pub const MAX: Size

The maximum possible Size

pub const fn new(width: u16, height: u16) -> Size

Create a new Size struct

pub const fn area(self) -> u32

Compute the total area of the size as a u32.

The multiplication uses u32 to avoid overflow when the width and height are at their u16 maximum values.

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 Debug for Size

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

Formats the value using the given formatter.

impl Default for Size

fn default() -> Size

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Size

fn deserialize<__D>( __deserializer: __D, ) -> Result<Size, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Size

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

Formats the value using the given formatter.

impl From<(u16, u16)> for Size

fn from(_: (u16, u16)) -> Size

Converts to this type from the input type.

impl From<Rect> for Size

fn from(rect: Rect) -> Size

Converts to this type from the input type.

impl From<Size> for Rect

fn from(size: Size) -> Rect

Creates a new Rect with the given size at Position::ORIGIN (0, 0).

impl Hash for Size

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

where __H: Hasher,

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

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 Size

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Size

impl Eq for Size

impl StructuralPartialEq for Size