Skip to main content

Spacing

Enum Spacing 

Source
#[non_exhaustive]
pub enum Spacing { Space(u16), Overlap(u16), }
Expand description

How adjacent panes relate along the split axis in a _spaced split: a fixed gap between them, or a shared, overlapping edge.

A plain u16 (the historic spacing parameter) converts to Space via From, so existing callers of split_h_spaced/split_v_spaced/split_h_n_spaced/ split_v_n_spaced keep compiling unchanged.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Space(u16)

Carve out a fixed n-cell gap between every adjacent pair of panes. The gap comes out of the area before constraints are resolved, so Fill/ Percent panes share only what’s left after every gap is reserved. No-op with fewer than two panes or n == 0.

§

Overlap(u16)

Shift every pane back by n cells so it overlaps the trailing edge of the previous pane, e.g. so two adjacent bordered panels can share one line of border instead of each drawing its own (ratatui’s Spacing::Overlap). Purely geometric: retroglyph does not merge the overlapping cells’ contents, so whichever pane is drawn last wins on the shared cells. No-op with fewer than two panes or n == 0.

Trait Implementations§

Source§

impl Clone for Spacing

Source§

fn clone(&self) -> Spacing

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 Spacing

Source§

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

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

impl From<u16> for Spacing

Source§

fn from(n: u16) -> Self

A plain cell count is a gap, matching the historic u16 spacing parameter.

Source§

impl PartialEq for Spacing

Source§

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

Source§

impl Eq for Spacing

Source§

impl StructuralPartialEq for Spacing

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.
§

impl<C> WithAlpha for C
where C: Copy,

§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see [AlphaFirst]).
§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see [AlphaLast]).