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. By convention, 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

pub fn zero() -> Self

pub fn get_component<T: Component>(&self) -> T

Get either the row or column of a location

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

Return the location that is distance above this one

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

Return the location that is distance below this one

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

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

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

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

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

Return the location that is distance away in the given direction

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

Return the location that is 1 away in the given direction

pub fn transpose(&self) -> Location

Swap the row and colimn of this Location

pub fn order_by<Major: Component>(self) -> OrderedLocation<Major>

pub fn row_ordered(self) -> RowOrderedLocation

pub fn column_ordered(self) -> ColumnOrderedLocation

Trait Implementations

impl Copy for Location

impl PartialEq<Location> for Location

fn eq(&self, other: &Location) -> bool

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

fn ne(&self, other: &Location) -> bool

This method tests for !=.

impl Eq for Location

impl<M: Component> AsMut<Location> for OrderedLocation<M>

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

Performs the conversion.

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Location

fn default() -> Location

Returns the "default value" for a type.

impl<R: Into<Row>, C: Into<Column>> From<(R, C)> for Location

fn from(value: (R, C)) -> Location

Performs the conversion.

impl<M: Component> From<OrderedLocation<M>> for Location

fn from(ord: OrderedLocation<M>) -> Self

Performs the conversion.

impl<M: Component> From<Location> for OrderedLocation<M>

fn from(location: Location) -> Self

Performs the conversion.

impl<M: Component> AsRef<Location> for OrderedLocation<M>

fn as_ref(&self) -> &Location

Performs the conversion.

impl Hash for Location

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: Into<Vector>> 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: Into<Vector>> 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: Into<Vector>> AddAssign<T> for Location

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T: Into<Vector>> 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.