Struct gridly::grid::View

pub struct View<'a, G: Grid + ?Sized, T: LocComponent> { /* fields omitted */ }

A view of the Rows or Columns in a grid.

This struct provides a row- or column-major view of a grid. For instance, a View<MyGrid, Row> is a View of all of the rows in MyGrid.

A view can be indexed over its major ordering. For example, a View<G, Row> can be indexed over rows,

Methods

impl<'a, G: Grid + ?Sized, T: LocComponent> View<'a, G, T>

pub unsafe fn get_unchecked(&self, index: T) -> SingleView<'a, G, T>

Get a view of a single row or column of the grid, without bounds checking the index.

pub fn get(&self, index: T) -> Result<SingleView<'a, G, T>, RangeError<T>>

Get a view of a single row or column of the grid. Returns a range error if the index is out of range.

Important traits for ComponentRange<C>

impl<C: Component> Iterator for ComponentRange<C> type Item = C;

pub fn range(&self) -> ComponentRange<T>

Get a range over all the row or column indexes of this view.

pub fn iter(
    &self
) -> impl Iterator<Item = SingleView<'a, G, T>> + DoubleEndedIterator + FusedIterator + ExactSizeIterator + Debug + Clone

Create an iterator over the rows or columns of the grid. Each iterated element is a SingleView, which is a view over a single row or column of the grid.