Struct gridly::prelude::Location

pub struct Location {
    pub row: Row,
    pub column: Column,
}

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 Row and a Column. Increasing row count downward and increasing columns count rightward.

Locations support arithmetic operations with Vectors. They can also be subtracted from each other to produce Vectors measuring the distance between them.

Fields

row: Row

column: Column

Implementations

impl Location

#[must_use]pub fn new(row: impl Into<Row>, column: impl Into<Column>) -> Self

Create a new location out of a row and a column

#[must_use]pub const fn zero() -> Self

Create a new location at (0, 0).

Trait Implementations

impl<T: VectorLike> Add<T> for Location

type Output = Location

The resulting type after applying the + operator.

#[must_use]fn add(self, rhs: T) -> Location

Performs the + operation.

impl<T: VectorLike> AddAssign<T> for Location

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Location

impl Debug for Location

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

Formats the value using the given formatter.

impl Default for Location

fn default() -> Location

Returns the "default value" for a type.

impl Eq for Location

impl Hash for Location

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, 

Feeds a slice of this type into the given Hasher.

impl LocationLike for Location

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

Get the row of this location.

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

Get the column of this location.

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

Convert this object into a Location struct.

#[must_use]fn get_component<T: Component>(&self) -> T

Get either the row or column of a location. This method is useful in code that is generic over the Row or Column.

#[must_use]fn above(&self, distance: impl Into<Rows>) -> Location

Return the location that is distance rows above this one

#[must_use]fn below(&self, distance: impl Into<Rows>) -> Location

Return the location that is distance rows below this one

#[must_use]fn left(&self, distance: impl Into<Columns>) -> Location

Return the location that is distance columns to the left of this one

#[must_use]fn right(&self, distance: impl Into<Columns>) -> Location

Return the location that is distance columns to the right of this one

#[must_use]fn add(&self, distance: impl VectorLike) -> Location

Return the location that is distance away from this one.

#[must_use]fn relative(&self, direction: Direction, distance: isize) -> Location

Return the location that is distance away in the given direction

#[must_use]fn step(&self, direction: Direction) -> Location

Return the location that is 1 away in the given direction

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

Swap the row and colimn of this Location

#[must_use]fn order_by<Major: Component>(self) -> Ordered<Self, Major>

Generically get strictly ordered version of this Location. The Major is the ordering; for example, order_by::<Row> will create a row-ordered Location. See row_ordered or column_ordered for an example.

#[must_use]fn row_ordered(self) -> RowOrdered<Self>

Get a strictly row-ordered version of this Location; that is, a location which is ordered by comparing the row, then the column.

#[must_use]fn column_ordered(self) -> ColumnOrdered<Self>

Get a strictly row-ordered version of this Location; that is, a location which is ordered by comparing the row, then the column.

impl<T: LocationLike> PartialEq<T> for Location

#[must_use]fn eq(&self, rhs: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: LocationLike> PartialOrd<T> for Location

Locations have a partial ordering. loc1 is considered greater than loc2 iff its row or its column are greater than those in loc2. This chart shows an example:

<<<??
<<<??
<<=>>
??>>>
??>>>

Cells marked > are considered greater than the center location (marked =), and cells marked '<' are less than the center location. Cells marked ? do not have an ordering with the center location.

For a strict ordering between all possible locations, see the Ordered wrapper struct, which allows for row-major or column-major orderings.

#[must_use]fn partial_cmp(&self, rhs: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Location

impl Sub<(Column, Row)> for Location

type Output = Vector

The resulting type after applying the - operator.

#[must_use]fn sub(self, (column, row): (Column, Row)) -> Vector

Performs the - operation.

impl Sub<(Row, Column)> for Location

type Output = Vector

The resulting type after applying the - operator.

#[must_use]fn sub(self, (row, column): (Row, Column)) -> Vector

Performs the - operation.

impl Sub<Location> for Location

type Output = Vector

The resulting type after applying the - operator.

#[must_use]fn sub(self, rhs: Location) -> Vector

Performs the - operation.

impl<T: VectorLike> Sub<T> for Location

type Output = Location

The resulting type after applying the - operator.

#[must_use]fn sub(self, rhs: T) -> Location

Performs the - operation.

impl<T: VectorLike> SubAssign<T> for Location

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.