Struct gridly::location::OrderedLocation

pub struct OrderedLocation<Major: Component> {
    pub location: Location,
    // some fields omitted
}

Rules for ordering a Location

OrderedLocation is a wrapper struct around a Location that supplies an Ord and PartialOrd implementation. The Major type parameter indicates which ordering is used; for instance, Ordering<Row> provides row-major ordering, where Locations are sorted first by row, then by column.

Fields

location: Location

Methods

impl<M: Component> OrderedLocation<M>

pub fn new(location: Location) -> Self

Methods from Deref<Target = Location>

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

Trait Implementations

impl<Major: Copy + Component> Copy for OrderedLocation<Major>

impl<Major: PartialEq + Component> PartialEq<OrderedLocation<Major>> for OrderedLocation<Major>

fn eq(&self, other: &OrderedLocation<Major>) -> bool

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

fn ne(&self, other: &OrderedLocation<Major>) -> bool

This method tests for !=.

impl<M: Component> PartialOrd<OrderedLocation<M>> for OrderedLocation<M>

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

fn lt(&self, rhs: &Self) -> bool

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

fn le(&self, rhs: &Self) -> bool

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

fn gt(&self, rhs: &Self) -> bool

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

fn ge(&self, rhs: &Self) -> bool

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

impl<Major: Component> Ord for OrderedLocation<Major>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Major: Eq + Component> Eq for OrderedLocation<Major>

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

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

Performs the conversion.

impl<Major: Clone + Component> Clone for OrderedLocation<Major>

fn clone(&self) -> OrderedLocation<Major>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Major: Default + Component> Default for OrderedLocation<Major>

fn default() -> OrderedLocation<Major>

Returns the "default value" for a type.

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<M: Component> DerefMut for OrderedLocation<M>

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

Mutably dereferences the value.

impl<M: Component> Deref for OrderedLocation<M>

type Target = Location

The resulting type after dereferencing.

fn deref(&self) -> &Location

Dereferences the value.

impl<Major: Hash + Component> Hash for OrderedLocation<Major>

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

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<Major: Debug + Component> Debug for OrderedLocation<Major>

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

Formats the value using the given formatter.