[−][src]Module gridly::prelude
The gridly prelude includes all traits and common structs.
Note that the prelude does not include the single-character shorthand functions, so as not to pollute your namespace with single-character identifiers on a bulk import.
Re-exports
pub use crate::direction::Down; |
pub use crate::direction::Left; |
pub use crate::direction::Right; |
pub use crate::direction::Up; |
pub use crate::rotation::Anticlockwise; |
pub use crate::rotation::Clockwise; |
Structs
Column | A
column
component of a |
Columns | A
columns
component of a |
Location | A location on a grid. A location is the primary indexing type for a
Grid, and represents a single cell on that grid. It is comprised of a
|
LocationRange | |
Row | |
Rows | A
rows
component of a |
Vector | A measurement of distance between two |
Enums
BoundsError | An out-of-bounds error for a Location on a grid |
Direction | The four cardinal directions: |
Rotation | The 4 cardinal rotations: |
Statics
DIAGONAL_ADJACENCIES | This array contains unit vectors associated with the 4 diagonal directions. It is intended to allow for easy iteration over diagonally adjacent locations. The order of the vectors is unspecified and should not be relied upon. |
EACH_DIRECTION | This array contains each direction; it is intended to allow for easy iteration over adjacent locations. The order of the directions is left unspecified and should not be relied upon. |
ORTHOGONAL_ADJACENCIES | This array contains unit vectors associated with the 4 orthogonally adjacent directions. It is intended to allow for easy iteration over orthogonally adjacent locations. The order of the vectors is unspecified and should not be relied upon. |
TOUCHING_ADJACENCIES | This array contains unit vectors associated with the 8 adjacent directions. It is intended to allow for easy iteration over all locations that touch a center location (for instance, when scanning adjacencies in an implementation of Conway's Game of Life). The order of the vectors is unspecified and should not be relied upon. |
Traits
Grid | Base Reader trait for grids. This trait provides the grid's cell type,
|
GridBounds | Grid trait implementing grid sizes and boundary checking. |
GridMut | |
GridSetter | Setter trait for grids. Allows setting and replacing elements in the grid. Implementors should implement the unsafe setter and replacer methods. This trait then provides implementations of safe, bounds-checked setters. |
LocationComponent | A component of a |
LocationLike | This trait covers structs that act like a |
VectorComponent | |
VectorLike |
|
Type Definitions
ColumnRange | |
ColumnRangeError | |
RowRange | |
RowRangeError |