Struct GridRef 

pub struct GridRef<'t> { /* private fields */ }

Resolved reference to a terminal cell position.

A grid reference is a resolved reference to a specific cell position in the terminal’s internal page structure. Obtain a grid reference from Terminal::grid_ref, then extract the cell or row via GridRef::cell and GridRef::row.

A grid reference is only valid until the next update to the terminal instance. There is no guarantee that a grid reference will remain valid after ANY operation, even if a seemingly unrelated part of the grid is changed, so any information related to the grid reference should be read and cached immediately after obtaining the grid reference.

This API is not meant to be used as the core of render loop. It isn’t built to sustain the framerates needed for rendering large screens. Use the render state API for that.

Implementations

impl GridRef<'_>

pub fn row(&self) -> Result<Row>

Get the row from a grid reference.

pub fn cell(&self) -> Result<Cell>

Get the cell from a grid reference.

pub fn style(&self) -> Result<Style>

Get the style of the cell at the grid reference’s position.

pub fn graphemes(&self, buf: &mut [char]) -> Result<usize>

Get the grapheme cluster codepoints for the cell at the grid reference’s position.

Writes the full grapheme cluster (the cell’s primary codepoint followed by any combining codepoints) into the provided buffer. If the cell has no text, Ok(0) is returned.

If the buffer is too small, the function returns Err(Error::OutOfSpace { required }) where required is the required number of codepoints. The caller can then retry with a sufficiently sized buffer.

Trait Implementations

impl<'t> Clone for GridRef<'t>

fn clone(&self) -> GridRef<'t>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for GridRef<'t>

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

Formats the value using the given formatter.