Struct TerminalGeometry

Source
pub struct TerminalGeometry {
    pub pixel_width: u32,
    pub pixel_height: u32,
    pub metrics: TerminalCellMetrics,
    pub cols: u16,
    pub rows: u16,
}
Expand description

Committed terminal viewport geometry.

pixel_width/pixel_height are rounded non-negative content extents in the runtime coordinate space. Grid dimensions are whole cells and normally stay within 1..=u16::MAX. Self::new itself stores all inputs unchanged.

§Examples

use ailloli_ui_widgets::controls::{TerminalCellMetrics, TerminalGeometry};
let geometry = TerminalGeometry::new(
    640,
    380,
    TerminalCellMetrics::new(8.0, 19.0, 14.0),
    80,
    20,
);
assert_eq!(geometry.terminal_size().cols, 80);

Fields§

§pixel_width: u32

Rounded content width, saturated at u32::MAX by runtime measurement.

§pixel_height: u32

Rounded content height, saturated at u32::MAX by runtime measurement.

§metrics: TerminalCellMetrics

Cell width, height, and baseline used to derive the grid.

§cols: u16

Visible column count in cells.

§rows: u16

Visible row count in cells.

Implementations§

Source§

impl TerminalGeometry

Source

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

Stores viewport geometry unchanged.

§Examples
use ailloli_ui_widgets::controls::{TerminalCellMetrics, TerminalGeometry};
let geometry = TerminalGeometry::new(800, 600, TerminalCellMetrics::new(8.0, 20.0, 14.0), 100, 30);
assert_eq!((geometry.pixel_width, geometry.rows), (800, 30));
Source

pub fn terminal_size(self) -> TerminalSize

Converts (rows, cols) to a core [TerminalSize].

TerminalSize::new replaces a zero row or column with one.

§Examples
use ailloli_ui_widgets::controls::{TerminalCellMetrics, TerminalGeometry};
let geometry = TerminalGeometry::new(0, 0, TerminalCellMetrics::new(1.0, 1.0, 1.0), 0, 0);
assert_eq!((geometry.terminal_size().rows, geometry.terminal_size().cols), (1, 1));
Source

pub fn viewport_size(self) -> TerminalViewportSize

Converts to the resize callback payload.

Pixel extents above u16::MAX saturate independently; grid dimensions pass through Self::terminal_size.

§Examples
use ailloli_ui_widgets::controls::{TerminalCellMetrics, TerminalGeometry};
let geometry = TerminalGeometry::new(100_000, 480, TerminalCellMetrics::new(8.0, 20.0, 14.0), 80, 24);
let viewport = geometry.viewport_size();
assert_eq!(viewport.pixel_width, u16::MAX);
assert_eq!(viewport.pixel_height, 480);

Trait Implementations§

Source§

impl Clone for TerminalGeometry

Source§

fn clone(&self) -> TerminalGeometry

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TerminalGeometry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TerminalGeometry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for TerminalGeometry

Source§

impl StructuralPartialEq for TerminalGeometry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,