Struct alacritty_terminal::grid::Grid

pub struct Grid<T> {
    pub cursor: Cursor,
    pub saved_cursor: Cursor,
    // some fields omitted
}

Grid based terminal content storage.

┌─────────────────────────┐  <-- max_scroll_limit + lines
│                         │
│      UNINITIALIZED      │
│                         │
├─────────────────────────┤  <-- self.raw.inner.len()
│                         │
│      RESIZE BUFFER      │
│                         │
├─────────────────────────┤  <-- self.history_size() + lines
│                         │
│     SCROLLUP REGION     │
│                         │
├─────────────────────────┤v lines
│                         │|
│     VISIBLE  REGION     │|
│                         │|
├─────────────────────────┤^ <-- display_offset
│                         │
│    SCROLLDOWN REGION    │
│                         │
└─────────────────────────┘  <-- zero
                          ^
                         cols

Fields

cursor: Cursor

Current cursor for writing data.

saved_cursor: Cursor

Last saved cursor.

Implementations

impl<T: GridCell + Default + PartialEq + Copy> Grid<T>

pub fn resize(&mut self, reflow: bool, lines: Line, cols: Column)

Resize the grid's width and/or height.

impl<T: GridCell + Default + PartialEq + Copy> Grid<T>

pub fn new(
    lines: Line,
    cols: Column,
    max_scroll_limit: usize,
    template: T
) -> Grid<T>

pub fn update_history(&mut self, history_size: usize)

Update the size of the scrollback history.

pub fn scroll_display(&mut self, scroll: Scroll)

pub fn scroll_down(
    &mut self,
    region: &Range<Line>,
    positions: Line,
    template: T
)

pub fn scroll_up(&mut self, region: &Range<Line>, positions: Line, template: T)

Move lines at the bottom toward the top.

This is the performance-sensitive part of scrolling.

pub fn clear_viewport(&mut self, template: T)

pub fn reset(&mut self, template: T)

Completely reset the grid state.

impl<T> Grid<T>

pub fn clamp_buffer_to_visible(&self, point: Point<usize>) -> Point

Clamp a buffer point to the visible region.

pub fn visible_to_buffer(&self, point: Point) -> Point<usize>

Convert viewport relative point to global buffer indexing.

pub fn display_iter(&self) -> DisplayIter<T>ⓘ

Important traits for DisplayIter<'a, T>

impl<'a, T: Copy + 'a> Iterator for DisplayIter<'a, T> type Item = Indexed<T>;

pub fn clear_history(&mut self)

pub fn initialize_all(&mut self, template: T) where
    T: Copy + GridCell, 

This is used only for initializing after loading ref-tests.

pub fn truncate(&mut self)

This is used only for truncating before saving ref-tests.

pub fn iter_from(&self, point: Point<usize>) -> GridIterator<T>ⓘ

Important traits for GridIterator<'a, T>

impl<'a, T> Iterator for GridIterator<'a, T> type Item = &'a T;

pub fn display_offset(&self) -> usize

pub fn cursor_cell(&mut self) -> &mut T

Trait Implementations

impl<T: Clone> Clone for Grid<T>

fn clone(&self) -> Grid<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Grid<T>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<G> Dimensions for Grid<G>

fn total_lines(&self) -> usize

Total number of lines in the buffer, this includes scrollback and visible lines.

fn screen_lines(&self) -> Line

Height of the viewport in lines.

fn cols(&self) -> Column

Width of the terminal in columns.

fn history_size(&self) -> usize

Number of invisible lines part of the scrollback history.

impl<'point, T> Index<&'point Point<Line>> for Grid<T>

type Output = T

The returned type after indexing.

fn index<'a>(&'a self, point: &Point) -> &'a T

Performs the indexing (container[index]) operation.

impl<T> Index<Line> for Grid<T>

Index active region by line.

type Output = Row<T>

The returned type after indexing.

fn index(&self, index: Line) -> &Row<T>

Performs the indexing (container[index]) operation.

impl<T> Index<Point<usize>> for Grid<T>

type Output = T

The returned type after indexing.

fn index(&self, point: Point<usize>) -> &T

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for Grid<T>

Index with buffer offset.

type Output = Row<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Row<T>

Performs the indexing (container[index]) operation.

impl<'point, T> IndexMut<&'point Point<Line>> for Grid<T>

fn index_mut<'a, 'b>(&'a mut self, point: &'b Point) -> &'a mut T

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<Line> for Grid<T>

fn index_mut(&mut self, index: Line) -> &mut Row<T>

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<Point<usize>> for Grid<T>

fn index_mut(&mut self, point: Point<usize>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<usize> for Grid<T>

fn index_mut(&mut self, index: usize) -> &mut Row<T>

Performs the mutable indexing (container[index]) operation.

impl<T> IndexRegion<Range<Line>, T> for Grid<T>

fn region(&self, index: Range<Line>) -> Region<T>

Get an immutable region of Self.

fn region_mut(&mut self, index: Range<Line>) -> RegionMut<T>

Get a mutable region of Self.

impl<T> IndexRegion<RangeFrom<Line>, T> for Grid<T>

fn region(&self, index: RangeFrom<Line>) -> Region<T>

Get an immutable region of Self.

fn region_mut(&mut self, index: RangeFrom<Line>) -> RegionMut<T>

Get a mutable region of Self.

impl<T> IndexRegion<RangeFull, T> for Grid<T>

fn region(&self, _: RangeFull) -> Region<T>

Get an immutable region of Self.

fn region_mut(&mut self, _: RangeFull) -> RegionMut<T>

Get a mutable region of Self.

impl<T> IndexRegion<RangeTo<Line>, T> for Grid<T>

fn region(&self, index: RangeTo<Line>) -> Region<T>

Get an immutable region of Self.

fn region_mut(&mut self, index: RangeTo<Line>) -> RegionMut<T>

Get a mutable region of Self.

impl<T: PartialEq> PartialEq<Grid<T>> for Grid<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> Serialize for Grid<T> where
    T: Serialize, 

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

Serialize this value into the given Serde serializer.