Skip to main content

Terminal

Struct Terminal 

Source
pub struct Terminal {
    pub id: WidgetId,
    pub cells: Vec<Vec<TerminalCell>>,
    pub scrollbar: Option<TerminalScrollbar>,
}
Expand description

Declarative description of a terminal cell grid.

cells[row][col] — outer Vec is rows top-to-bottom, inner Vec is columns left-to-right. Rows may be ragged (different lengths) but backends should treat missing trailing cells as blank.

Stays a plain, non-#[non_exhaustive] struct: a published consumer builds it with an exhaustive struct literal today, so marking it #[non_exhaustive] would break that consumer’s build. Default is still provided for consumers that want the Default::default()-plus-field-assignment pattern.

§Examples

use quadraui::{Color, Terminal, TerminalCell, TerminalHit, WidgetId};

let cell = TerminalCell {
    text: "$".to_string(),
    fg: Color::rgb(200, 200, 200),
    bg: Color::rgb(0, 0, 0),
    bold: false,
    italic: false,
    underline: false,
    dim: false,
    selected: false,
    is_cursor: true,
    cursor_shape: Default::default(),
    cursor_blinking: false,
    is_find_match: false,
    is_find_active: false,
};

let mut terminal = Terminal::default();
terminal.id = WidgetId::new("terminal:shell");
terminal.cells = vec![vec![cell]];

let layout = terminal.layout(80.0, 24.0, 1.0, 1.0);
assert_eq!(layout.hit_test(0.0, 0.0), TerminalHit::Cell { row: 0, col: 0 });

Fields§

§id: WidgetId§cells: Vec<Vec<TerminalCell>>§scrollbar: Option<TerminalScrollbar>

When present, the rasteriser draws a themed scrollbar using the same style as editor scrollbars (Backend::draw_scrollbar).

Implementations§

Source§

impl Terminal

Source

pub fn dirty_rows(&self, prev: &Terminal) -> Option<Vec<usize>>

Compare self against the previously-painted prev snapshot and return the indices of rows whose cell content differs.

Returns None when a full repaint is required rather than a row-by-row diff: the two grids have different row counts, so prev’s row i doesn’t necessarily correspond to self’s row i (a resize/reflow shifted everything). Returns Some(rows) otherwise — sorted ascending, deduplicated, and possibly empty (e.g. a cursor-blink tick that produced an identical grid).

TerminalCell compares by value, so any change to a cell’s glyph, colour, or overlay flag (selected / is_cursor / is_find_match / is_find_active) — i.e. scroll, selection, cursor move, and find-highlight updates — registers the owning row as dirty; there is nothing overlay-specific for a caller to special-case.

Source

pub fn layout( &self, viewport_width: f32, viewport_height: f32, cell_width: f32, cell_height: f32, ) -> TerminalLayout

Compute viewport → grid conversion. The layout is uniform-cell, so this is just division; there’s no per-cell work.

§Arguments
  • viewport_width, viewport_height — pane dimensions.
  • cell_width, cell_height — cell dimensions. TUI passes (1.0, 1.0); native backends pass the font’s advance width and line height.

Trait Implementations§

Source§

impl Clone for Terminal

Source§

fn clone(&self) -> Self

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 Terminal

Source§

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

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

impl Default for Terminal

Source§

fn default() -> Self

An empty-id terminal with no cells and no scrollbar.

Source§

impl<'de> Deserialize<'de> for Terminal

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Terminal

Source§

impl PartialEq for Terminal

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Terminal

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Terminal

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Instrument for T

Source§

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

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

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> 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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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