Struct gridly::grid::View

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

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. The view can be indexed over its type (for instance, a View<G, Row> can be indexed by Row). It can also be iterated, where each iteration step produces a SingleView, which is a view of a single row or column (that single view can itself be iterated to get all the cells).

Implementations

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

pub fn len(&self) -> T::Distance

Get the length of this view; that is, the number of Rows or Columns

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.

Safety

Callers must ensure that the index has been bounds-checked before calling this method.

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.

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.

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

pub fn row(&self, row: impl Into<Row>) -> Result<RowView<'a, G>, RowRangeError>

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

pub fn column( &self, column: impl Into<Column> ) -> Result<ColumnView<'a, G>, ColumnRangeError>

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.