Skip to main content

Available

Struct Available 

Source
pub struct Available { /* private fields */ }
Expand description

The area a view may occupy: an input to layout, not an afterthought.

A terminal width or a Ratatui Rect becomes an Available. It flows down the tree and each node resolves its own size under it, so a frame closes at whatever size the area forces. It is not a clip applied to a finished rectangle; the only crop left is the degenerate-case safety net in resolve.

An absent bound is not zero: it means the axis is unbounded, which is what measure resolves under and what makes an intrinsic size the same computation as a bounded one.

Implementations§

Source§

impl Available

Source

pub const NONE: Self

Imposes no bound on either axis.

Source

pub const fn new(width: Option<usize>, height: Option<usize>) -> Self

Source

pub const fn columns(width: usize) -> Self

Bounds the width only — a terminal of a known width and no known height.

Source

pub const fn size(width: usize, height: usize) -> Self

Bounds both axes.

Source

pub const fn width(&self) -> Option<usize>

Source

pub const fn height(&self) -> Option<usize>

Trait Implementations§

Source§

impl Clone for Available

Source§

fn clone(&self) -> Available

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Available

Source§

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

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

impl Default for Available

Source§

fn default() -> Available

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Available

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Available

Source§

impl Eq for Available

Source§

impl StructuralPartialEq for Available

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.

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.

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.