Struct TermGrid 

pub struct TermGrid<E, S> { /* private fields */ }

Available on crate feature term only.

🮖 🗃️ A dense row-major grid of terminal-space elements.

---

^{📍 sys/os/term/grid::TermGrid}

---

The grid occupies the first width × height elements of its storage. Any remaining storage is retained but lies outside the grid.

Methods

• Construction and structural access

  • new.
  • extent.
  • width.
  • height.
  • len.
  • is_empty.
  • storage (into, slice).
  • as_slice.
  • spare_len.

• Coordinate queries

  • contains.
  • index_of.
  • position_of.
  • get (xy).
  • row.

• Mutable access

  • as_mut_slice.
  • storage_slice_mut.
  • get_mut (xy).
  • row_mut.
  • set (xy).

• Text drawing

  • write_str_at
  • write_str_xy

• Copy-oriented operations

  • fill.
  • get_copy (xy).

• Region drawing

  • fill_region.
  • hline.
  • vline.
  • frame.

• Grid transfer

  • blit_at.
  • blit_region_at.

Implementations

impl<E, S: AsRef<[E]>> TermGrid<E, S>

Construction and structural access

pub fn new(storage: S, extent: Extent2<usize>) -> Result<Self, TermGridError>

Creates a grid over the active prefix of storage.

Errors

Returns an error if the extent overflows or the storage is too short.

pub const fn extent(&self) -> Extent2<usize>

Returns the grid extent in columns and rows.

pub const fn width(&self) -> usize

Returns the number of columns.

pub const fn height(&self) -> usize

Returns the number of rows.

pub const fn len(&self) -> usize

Returns the number of active grid elements.

pub const fn is_empty(&self) -> bool

Returns whether the grid contains no active elements.

pub const fn storage(&self) -> &S

Returns the complete backing storage.

pub fn into_storage(self) -> S

Consumes the grid and returns its backing storage.

pub fn storage_slice(&self) -> &[E]

Returns the complete backing-storage slice.

pub fn as_slice(&self) -> &[E]

Returns the active row-major grid elements.

pub fn spare_len(&self) -> usize

Returns the number of elements outside the active grid.

impl<E, S: AsRef<[E]>> TermGrid<E, S>

Coordinate queries

pub const fn contains(&self, pos: Position2<usize>) -> bool

Returns whether the position lies within the grid.

pub const fn index_of(&self, pos: Position2<usize>) -> Option<usize>

Returns the row-major index of pos, or None when outside the grid.

pub const fn position_of(&self, index: usize) -> Option<Position2<usize>>

Returns the position of an active row-major index.

pub fn get(&self, pos: Position2<usize>) -> Option<&E>

Returns the element at pos.

pub fn get_xy(&self, x: usize, y: usize) -> Option<&E>

Returns the element at the given coordinates.

pub fn row(&self, y: usize) -> Option<&[E]>

Returns the active row.

impl<E, S: AsRef<[E]> + AsMut<[E]>> TermGrid<E, S>

Mutable access

pub fn as_mut_slice(&mut self) -> &mut [E]

Returns the active row-major grid elements exclusively.

pub fn storage_slice_mut(&mut self) -> &mut [E]

Returns the complete backing-storage slice exclusively.

pub fn get_mut(&mut self, pos: Position2<usize>) -> Option<&mut E>

Returns the element at pos exclusively.

pub fn get_xy_mut(&mut self, x: usize, y: usize) -> Option<&mut E>

Returns the element at the given coordinates exclusively.

pub fn row_mut(&mut self, y: usize) -> Option<&mut [E]>

Returns the active row exclusively.

pub fn set(&mut self, pos: Position2<usize>, element: impl Into<E>) -> bool

Replaces the element at pos.

Returns false when the position lies outside the grid.

pub fn set_xy(&mut self, x: usize, y: usize, element: impl Into<E>) -> bool

Replaces the element at the given coordinates.

Returns false when the coordinates lie outside the grid.

impl<E: Copy, S: AsRef<[E]> + AsMut<[E]>> TermGrid<E, S>

Copy-oriented operations

pub fn fill(&mut self, element: E)

Fills the active grid with element.

pub fn get_copy(&self, pos: Position2<usize>) -> Option<E>

Returns a copy of the element at pos.

pub fn get_xy_copy(&self, x: usize, y: usize) -> Option<E>

Returns a copy of the element at the given coordinates.

impl<S: Copy, C: Copy, D> TermGrid<Termel<char, S, C>, D>

where D: AsRef<[Termel<char, S, C>]> + AsMut<[Termel<char, S, C>]>,

Text drawing

pub fn write_str_at( &mut self, position: Position2<usize>, text: &str, pen: TermPen<S, C>, ) -> usize

Writes width-one Unicode scalars horizontally at position.

Writing stops at the right grid edge. No wrapping, line-break handling, grapheme segmentation, or terminal-width calculation is performed.

Returns the number of cells written.

pub fn write_str_xy( &mut self, x: usize, y: usize, text: &str, pen: TermPen<S, C>, ) -> usize

Writes width-one Unicode scalars horizontally at (x, y).

Returns the number of cells written.

impl<E: Copy, S: AsRef<[E]> + AsMut<[E]>> TermGrid<E, S>

Region drawing

pub fn fill_region(&mut self, region: RegionS2<usize>, element: impl Into<E>)

Fills the part of region lying within the grid.

Regions extending beyond the grid are clipped.

pub fn hline(&mut self, x: usize, y: usize, len: usize, element: impl Into<E>)

Fills a clipped horizontal span.

pub fn vline(&mut self, x: usize, y: usize, len: usize, element: impl Into<E>)

Fills a clipped vertical span.

pub fn frame(&mut self, region: RegionS2<usize>, element: impl Into<E>)

Draws a clipped one-cell frame around region.

impl<E: Copy, D> TermGrid<E, D>

where D: AsRef<[E]> + AsMut<[E]>,

Grid transfer

pub fn blit_at<S>( &mut self, source: &TermGrid<E, S>, destination: Position2<usize>, )

where S: AsRef<[E]>,

Copies source into this grid at destination.

Cells extending beyond the destination grid are clipped.

pub fn blit_region_at<S>( &mut self, source: &TermGrid<E, S>, source_region: RegionS2<usize>, destination: Position2<usize>, )

where S: AsRef<[E]>,

Copies a source region into this grid at destination.

Both the source region and destination grid are clipped.

Trait Implementations

impl<E: Clone, S: Clone> Clone for TermGrid<E, S>

fn clone(&self) -> TermGrid<E, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy, S: Copy> Copy for TermGrid<E, S>

impl<E: Debug, S: Debug> Debug for TermGrid<E, S>

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

Formats the value using the given formatter.

impl<E: Eq, S: Eq> Eq for TermGrid<E, S>

impl<E: Hash, S: Hash> Hash for TermGrid<E, S>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: PartialEq, S: PartialEq> PartialEq for TermGrid<E, S>

fn eq(&self, other: &TermGrid<E, S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<E: PartialEq, S: PartialEq> StructuralPartialEq for TermGrid<E, S>