Struct Cell

Source

pub struct Cell {
    pub fg: Color,
    pub bg: Color,
    pub underline_color: Color,
    pub modifier: Modifier,
    pub skip: bool,
    /* private fields */
}

Expand description

A buffer cell

Fields§

§fg: Color

The foreground color of the cell.

§bg: Color

The background color of the cell.

§underline_color: Color

The underline color of the cell.

§modifier: Modifier

The modifier of the cell.

§skip: bool

Whether the cell should be skipped when copying (diffing) the buffer to the screen.

Implementations§

Source §

impl Cell

Source

pub const EMPTY: Cell

An empty Cell

Source

pub const fn new(symbol: &'static str) -> Cell

Creates a new Cell with the given symbol.

This works at compile time and puts the symbol onto the stack. Fails to build when the symbol doesnt fit onto the stack and requires to be placed on the heap. Use Self::default().set_symbol() in that case. See CompactString::const_new for more details on this.

Source

pub fn symbol(&self) -> &str

Gets the symbol of the cell.

Source

pub fn merge_symbol( &mut self, symbol: &str, strategy: MergeStrategy, ) -> &mut Cell

Merges the symbol of the cell with the one already on the cell, using the provided MergeStrategy.

Merges Box Drawing Unicode block characters to create a single character representing their combination, useful for border collapsing. Currently limited to box drawing characters, with potential future support for others.

Merging may not be perfect due to Unicode limitations; some symbol combinations might not produce a valid character. MergeStrategy defines how to handle such cases, e.g., Exact for valid merges only, or Fuzzy for close matches.

§Example

use ratatui_core::symbols::merge::MergeStrategy;

assert_eq!(
    Cell::new("┘")
        .merge_symbol("┏", MergeStrategy::Exact)
        .symbol(),
    "╆",
);

assert_eq!(
    Cell::new("╭")
        .merge_symbol("┘", MergeStrategy::Fuzzy)
        .symbol(),
    "┼",
);

Source

pub fn set_symbol(&mut self, symbol: &str) -> &mut Cell

Sets the symbol of the cell.

Source

pub fn set_char(&mut self, ch: char) -> &mut Cell

Sets the symbol of the cell to a single character.

Source

pub const fn set_fg(&mut self, color: Color) -> &mut Cell

Sets the foreground color of the cell.

Source

pub const fn set_bg(&mut self, color: Color) -> &mut Cell

Sets the background color of the cell.

Source

pub fn set_style<S>(&mut self, style: S) -> &mut Cell
where S: Into<Style>,

Sets the style of the cell.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

Source

pub const fn style(&self) -> Style

Returns the style of the cell.

Source

pub const fn set_skip(&mut self, skip: bool) -> &mut Cell

Sets the cell to be skipped when copying (diffing) the buffer to the screen.

This is helpful when it is necessary to prevent the buffer from overwriting a cell that is covered by an image from some terminal graphics protocol (Sixel / iTerm / Kitty …).

Source

pub fn reset(&mut self)

Resets the cell to the empty state.

Trait Implementations§

Source §

impl Clone for Cell

Source §

fn clone(&self) -> Cell

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Cell

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Cell

Source §

fn default() -> Cell

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

Source §

impl<'de> Deserialize<'de> for Cell

Source §

fn deserialize<D>( deserializer: D, ) -> Result<Cell, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl From<char> for Cell

Source §

fn from(ch: char) -> Cell

Converts to this type from the input type.

Source §

impl Hash for Cell

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl PartialEq for Cell

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

const 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 Serialize for Cell

Source §

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. Read more

Source §

impl Eq for Cell

Source §

impl StructuralPartialEq for Cell

Auto Trait Implementations§

§

impl UnwindSafe for Cell

Blanket Implementations§

Source §

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source §

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.

Source §

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.

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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source §

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.

Source §

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source §

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.

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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source §

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

Source §

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

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, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source §

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.

Source §

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FromAngle<T> for T

Source §

fn from_angle(angle: T) -> T

Performs a conversion from angle.

Source §

impl<T, U> FromStimulus for T
where U: IntoStimulus<T>,

Source §

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.

Source §

impl<T, U> Into 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, U> IntoAngle for T
where U: FromAngle<T>,

Source §

fn into_angle(self) -> U

Performs a conversion into T.

Source §

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source §

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.

Source §

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, >::Scalar>, ) -> T

Converts self into C, using the provided parameters.

Source §

impl<T, U> IntoColor for T
where U: FromColor<T>,

Source §

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

Source §

impl<T, U> IntoColorUnclamped for T
where U: FromColorUnclamped<T>,

Source §

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> IntoStimulus<T> for T

Source §

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.

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, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source §

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.

Source §

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<T, U> TryIntoColor for T
where U: TryFromColor<T>,

Source §

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

Source §

impl<C, U> UintsFrom<C> for U
where C: IntoUints,

Source §

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.

Source §

impl<C, U> UintsInto<C> for U
where C: FromUints,

Source §

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.

Source §

Struct CellCopy item path

Fields§

Implementations§

impl Cell

pub const EMPTY: Cell

pub const fn new(symbol: &'static str) -> Cell

pub fn symbol(&self) -> &str

pub fn merge_symbol( &mut self, symbol: &str, strategy: MergeStrategy, ) -> &mut Cell

§Example

pub fn set_symbol(&mut self, symbol: &str) -> &mut Cell

pub fn set_char(&mut self, ch: char) -> &mut Cell

pub const fn set_fg(&mut self, color: Color) -> &mut Cell

pub const fn set_bg(&mut self, color: Color) -> &mut Cell

pub fn set_style<S>(&mut self, style: S) -> &mut Cellwhere S: Into<Style>,

pub const fn style(&self) -> Style

pub const fn set_skip(&mut self, skip: bool) -> &mut Cell

pub fn reset(&mut self)

Trait Implementations§

impl Clone for Cell

fn clone(&self) -> Cell

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

impl Debug for Cell

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

impl Default for Cell

fn default() -> Cell

impl<'de> Deserialize<'de> for Cell

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

impl From<char> for Cell

fn from(ch: char) -> Cell

impl Hash for Cell

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

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

impl PartialEq for Cell

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

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

impl Serialize for Cell

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

impl Eq for Cell

impl StructuralPartialEq for Cell

Auto Trait Implementations§

impl Freeze for Cell

impl RefUnwindSafe for Cell

impl Send for Cell

impl Sync for Cell

impl Unpin for Cell

impl UnwindSafe for Cell

Blanket Implementations§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> Dwhere M: TransformMatrix<T>,

fn adapt_into(self) -> D

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

fn type_id(&self) -> TypeId

impl<T, C> ArraysFrom<C> for Twhere C: IntoArrays<T>,

fn arrays_from(colors: C) -> T

impl<T, C> ArraysInto<C> for Twhere C: FromArrays<T>,

fn arrays_into(self) -> C

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

fn borrow(&self) -> &T

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

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

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere T: FromCam16Unclamped<WpParam, U>,

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T, C> ComponentsFrom<C> for Twhere C: IntoComponents<T>,

fn components_from(colors: C) -> T

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromAngle<T> for T

fn from_angle(angle: T) -> T

impl<T, U> FromStimulus<U> for Twhere U: IntoStimulus<T>,

fn from_stimulus(other: U) -> T

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

fn into(self) -> U

impl<T, U> IntoAngle<U> for Twhere U: FromAngle<T>,

fn into_angle(self) -> U

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere T: Cam16FromUnclamped<WpParam, U>,

Struct Cell

pub fn set_style<S>(&mut self, style: S) -> &mut Cell
where S: Into<Style>,

fn deserialize<D>( deserializer: D, ) -> Result<Cell, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

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

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

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

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

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

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

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

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

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

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

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

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

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

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,