Struct gridly_adapters::Window

pub struct Window<G> { /* fields omitted */ }

Grid adapter that views a subset of the wrapped grid, using the same coordinate system. For instance, given this grid:

OOOOO
OOOOO
OOOOO
OOOOO

A window with a root of (1, 1) and dimensions of (2, 2) will cover this region:

OOOOO
OXXOO
OXXOO
OOOOO

Example

use gridly_grids::VecGrid;
use gridly_adapters::Window;
use gridly::prelude::*;

let grid: VecGrid<i32> = VecGrid::new_row_major(
    Rows(4) + Columns(5),
    1..
).unwrap();

let grid = Window::new(
    grid,
    Row(1) + Column(1),
    Rows(2) + Columns(2),
);

assert_eq!(grid.get((0, 0)).ok(), None);
assert_eq!(grid.get((1, 1)).ok(), Some(&7));
assert_eq!(grid.get((2, 2)).ok(), Some(&13));
assert_eq!(grid.get((3, 3)).ok(), None);

Implementations

impl<G: GridBounds> Window<G>

pub fn new(
    grid: G,
    root: impl LocationLike,
    dimensions: impl VectorLike
) -> Self

impl<G> Window<G>

pub fn into_inner(self) -> G

Trait Implementations

impl<G> AsMut<G> for Window<G>

fn as_mut(&mut self) -> &mut G

Performs the conversion.

impl<G> AsRef<G> for Window<G>

fn as_ref(&self) -> &G

Performs the conversion.

impl<G: Clone> Clone for Window<G>

fn clone(&self) -> Window<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug> Debug for Window<G>

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

Formats the value using the given formatter.

impl<G: Grid> Grid for Window<G>

type Item = G::Item

The item type stored in the grid

unsafe fn get_unchecked(&self, location: Location) -> &Self::Item

Get a reference to a cell, without doing bounds checking. Implementors of this method are allowed to assume that bounds checking has already been performed on the location, which means that implementors are allowed to do their own unsafe get operations on the underlying storage, where relevant / possible.

fn get(&self, location: impl LocationLike) -> Result<&Self::Item, BoundsError>

Get a reference to a cell in a grid. Returns an error if the location is out of bounds with the specific boundary violation.

fn view<T>(&self) -> View<'_, Self, T> where
    T: Component, 

Get a view of a grid, over its rows or columns. A view of a grid is similar to a slice, but instead of being a view over specific elements, it's a view over the rows and columns. See [View] for details.

fn rows(&self) -> View<'_, Self, Row>

Get a view of a grid's rows. See [View] for details.

fn columns(&self) -> View<'_, Self, Column>

Get a view of a grid's columns. See [View] for details.

unsafe fn single_view_unchecked<T>(&self, index: T) -> SingleView<'_, Self, T> where
    T: Component, 

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

unsafe fn row_unchecked(&self, row: Row) -> SingleView<'_, Self, Row>

Get a view of a single row in a grid, without bounds checking that row's index.

unsafe fn column_unchecked(
    &self,
    column: Column
) -> SingleView<'_, Self, Column>

Get a view of a single column in a grid, without bounds checking that column's index.

fn single_view<T>(
    &self,
    index: T
) -> Result<SingleView<'_, Self, T>, RangeError<T>> where
    T: Component, 

Get a view of a single row or column in a grid. Returns an error if the index of the row or column is out of bounds for the grid.

fn row(
    &self,
    row: impl Into<Row>
) -> Result<SingleView<'_, Self, Row>, RangeError<Row>>

Get a view of a single row in a grid. Returns an error if the index of the row is out of bounds for the grid.

fn column(
    &self,
    column: impl Into<Column>
) -> Result<SingleView<'_, Self, Column>, RangeError<Column>>

Get a view of a single column in a grid. Returns an error if the index of the column is out of bounds for the grid.

fn display_with<T, F>(&self, func: F) -> DisplayAdapter<&Self, F> where
    F: Fn(&Self::Item) -> T,
    T: Display, 

Make a grid Displayable, using a function that defines how each of its cells are printed. For each row, the adapter simply prints each cell in the row, followed by a newline.

impl<G: GridBounds> GridBounds for Window<G>

fn dimensions(&self) -> Vector

Get the dimensions of the grid, as a Vector. The dimensions of must be >= 0.

fn root(&self) -> Location

Return the root location (ie, the top left) of the grid. All valid locations on the grid have location >= root. For most grids, this can just be Location::zero

#[must_use]fn outer_bound(&self) -> Location

Get the outer bound of the grid; that is, the location for which all valid locations in the grid have row < outer.row && column < outer.column

#[must_use]fn num_rows(&self) -> Rows

Get the height of the grid in Rows.

#[must_use]fn num_columns(&self) -> Columns

Get the width of the grid, in Columns.

#[must_use]fn dimension<C>(&self) -> C where
    C: Component, 

Get the height or width of this grid.

#[must_use]fn root_row(&self) -> Row

Return the index of the topmost row of this grid. For most grids, this is 0, but some grids may include negatively indexed locations, or even offsets.

#[must_use]fn root_column(&self) -> Column

Return the index of the leftmost column of this grid. For most grids, this is 0, but some grids may include negatively indexed locations, or even offsets.

#[must_use]fn root_component<C>(&self) -> C where
    C: Component, 

Return the index of the leftmost column or topmost row of this grid.

#[must_use]fn row_range(&self) -> ComponentRange<Row>

Get a range iterator over all the Row indexes in this grid

#[must_use]fn column_range(&self) -> ComponentRange<Column>

Get a range iterator over all the Column indexes in this grid

#[must_use]fn range<C>(&self) -> ComponentRange<C> where
    C: Component, 

Get a range iterator over the row or column indexes

fn check_component<C>(&self, c: C) -> Result<C, RangeError<C>> where
    C: Component, 

Check that a Row or a Column is inside the bounds described by this grid. Returns the component if it's inside the bounds, or an error describing the violated boundary if not. This function is intended to help write more expressive code; ie, grid.check_component(Row(10)).and_then(|row| ...).

fn check_row(&self, row: impl Into<Row>) -> Result<Row, RangeError<Row>>

Check that a Row is inside the bounds described by this grid. Returns the component if it's inside the bounds, or an error describing the violated boundary if not. This function is intended to help write more expressive code; ie, grid.check_row(10).and_then(|row| ...).

fn check_column(
    &self,
    column: impl Into<Column>
) -> Result<Column, RangeError<Column>>

Check that a Column is inside the bounds described by this grid. Returns the component if it's inside the bounds, or an error describing the violated boundary if not. This function is intended to help write more expressive code; ie, grid.check_column(10).and_then(|row| ...).

#[must_use]fn component_in_bounds<C>(&self, c: C) -> bool where
    C: Component, 

Returns true if a Row or Column is inside the bounds described by this grid.

#[must_use]fn row_in_bounds(&self, row: impl Into<Row>) -> bool

Returns true if a Row is inside the bounds described by this grid.

#[must_use]fn column_in_bounds(&self, column: impl Into<Column>) -> bool

Returns true if a Column is inside the bounds described by this grid.

fn check_location(
    &self,
    location: impl LocationLike
) -> Result<Location, BoundsError>

Check that a location is inside the bounds of this grid.

#[must_use]fn location_in_bounds(&self, location: impl LocationLike) -> bool

Returns true if a locaton is inside the bounds of this grid.

impl<G: GridMut> GridMut for Window<G>

unsafe fn get_unchecked_mut(&mut self, location: Location) -> &mut Self::Item

Get a mutable reference to a cell, without doing bounds checking. Implementors of this method are allowed to assume that bounds checking has already been performed on the location, which means that implementors are allowed to do their own unsafe get_mut operations on the underlying storage, where relevant / possible.

fn get_mut(
    &mut self,
    location: impl LocationLike
) -> Result<&mut Self::Item, BoundsError>

Get a reference to a cell in a grid. Returns an error if the location is out of bounds with the specific boundary violation.

impl<G: GridSetter> GridSetter for Window<G>

unsafe fn replace_unchecked(
    &mut self,
    location: Location,
    value: Self::Item
) -> Self::Item

Replace the value at the given location with value, without bounds checking location. Returns the previous value in the grid.

unsafe fn set_unchecked(&mut self, location: Location, value: Self::Item)

Replace the value at the given location with value, without bounds checking location.

fn replace(
    &mut self,
    location: impl LocationLike,
    value: Self::Item
) -> Result<Self::Item, BoundsError>

Replace the value at the given location with value. Returns the previous value in the grid, or an error if the location was out of bounds.

fn set(
    &mut self,
    location: impl LocationLike,
    value: Self::Item
) -> Result<(), BoundsError>

Set the value at the given location in the grid. Returns an error if the location was out of bounds.