Struct gridly::location::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 rows count downward and increasing columns count rightward.

Locations support arithmetic operations with Vectors.

Fields

row: Row

column: Column

Methods

impl Location

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

Create a new location out of a row and a column

pub const fn zero() -> Self

Create a new location at (0, 0).

Trait Implementations

impl LocationLike for Location

fn row(&self) -> Row

fn column(&self) -> Column

fn as_location(&self) -> Location

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.

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

Return the location that is distance rows above this one

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

Return the location that is distance rows below this one

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

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

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

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

fn add(&self, distance: impl VectorLike) -> Location

fn relative(&self, direction: Direction, distance: isize) -> Location

Return the location that is distance away in the given direction

fn step(&self, direction: Direction) -> Location

Return the location that is 1 away in the given direction

fn transpose(&self) -> Location

Swap the row and colimn of this Location

fn order_by<Major: Component>(self) -> OrderedLocation<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.

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 columns.

fn column_ordered(self) -> ColumnOrdered<Self>

which is ordered by comparing the row, then the columns.

impl Eq for Location

impl Default for Location

fn default() -> Location

Returns the "default value" for a type.

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<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 OrderedLocation wrapper struct, which allows for row-major or column-major orderings.

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<T: LocationLike> PartialEq<T> for Location

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 Copy 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<T: VectorLike> Add<T> for Location

type Output = Location

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Location

Performs the + operation.

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

type Output = Location

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Location

Performs the - operation.

impl Sub<Location> for Location

type Output = Vector

The resulting type after applying the - operator.

fn sub(self, rhs: Location) -> Vector

Performs the - operation.

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

fn add_assign(&mut self, rhs: T)

Performs the += operation.

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

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl Debug for Location

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

Formats the value using the given formatter.