Skip to main content

Cell

Struct Cell 

Source
pub struct Cell {
    pub codepoint: u32,
    pub fg: u32,
    pub bg: u32,
    pub flags: u16,
    /* private fields */
}
Expand description

One renderable cell. Exactly 16 bytes: codepoint (4) + fg (4) + bg (4) + flags (2) + padding (2). 4 cells per 64-byte cache line, which makes row walks cache-friendly.

Construction is direct (Cell { codepoint, fg, bg, flags, .. }) or via the [Cell::blank] / Cell::with_codepoint constructors below.

Fields§

§codepoint: u32

Unicode scalar value. 0 is the empty/blank cell sentinel.

§fg: u32

0xRRGGBB. Theme-resolved foreground colour.

§bg: u32

0xRRGGBB. Theme-resolved background colour; 0 is “transparent” → renderer uses the pane background.

§flags: u16

Bit flags from flags.

Implementations§

Source§

impl Cell

Source

pub const BLANK: Self

All-zero cell: blank codepoint, transparent fg/bg, no flags. The default value for unused trailing cells in a shorter-than-row source line.

Source

pub const fn with_codepoint(codepoint: u32) -> Self

Construct a default-coloured cell at codepoint. fg/bg default to 0 (renderer fills from theme); call sites that know colours should construct the struct literal directly.

Source

pub const fn new(codepoint: u32, fg: u32, bg: u32, flags: u16) -> Self

Convenience builder used in tests + cell-builder fixtures. Direct struct construction is the normal path.

Source

pub fn is_blank(&self) -> bool

true when the cell has the blank-sentinel codepoint. Does not consider fg/bg/flags — a blank-codepoint cell with a non-zero bg is still considered blank for content purposes (it’s used for trailing-cell padding within a row).

Source

pub fn is_inlay(&self) -> bool

true when this cell came from an inlay-hint splice.

Source

pub fn is_ws_marker(&self) -> bool

true when this cell is a whitespace marker glyph.

Source

pub fn is_bold(&self) -> bool

S3.a: true iff the bold modifier bit is set.

Source

pub fn is_italic(&self) -> bool

S3.a: true iff the italic modifier bit is set.

Source

pub fn is_underline(&self) -> bool

S3.a: true iff the underline modifier bit is set.

Source

pub fn is_dim(&self) -> bool

S3.a: true iff the dim modifier bit is set.

Source

pub fn is_reverse(&self) -> bool

S3.a: true iff the reverse modifier bit is set.

Trait Implementations§

Source§

impl Clone for Cell

Source§

fn clone(&self) -> Cell

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 Copy for Cell

Source§

impl Debug for Cell

Source§

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

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

impl Default for Cell

Source§

fn default() -> Self

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

impl Eq for Cell

Source§

impl Hash for Cell

Source§

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

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

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 UnsafeUnpin for Cell

§

impl UnwindSafe for Cell

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.

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