Struct gridly::location::Ordered

pub struct Ordered<L: LocationLike, Major: Component> {
    pub location: L,
    // some fields omitted
}

Rules for ordering a location. This struct wraps a LocationLike and 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: L

Methods

impl<L: LocationLike, M: Component> Ordered<L, M>

#[must_use] pub fn new(location: L) -> Self

Trait Implementations

impl<L: LocationLike, M: Component> AsMut<L> for Ordered<L, M>

#[must_use] fn as_mut(&mut self) -> &mut L

Performs the conversion.

impl<L: LocationLike, M: Component> AsRef<L> for Ordered<L, M>

#[must_use] fn as_ref(&self) -> &L

Performs the conversion.

impl<L: Clone + LocationLike, Major: Clone + Component> Clone for Ordered<L, Major>

fn clone(&self) -> Ordered<L, Major>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Copy + LocationLike, Major: Copy + Component> Copy for Ordered<L, Major>

impl<L: Debug + LocationLike, Major: Debug + Component> Debug for Ordered<L, Major>

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

Formats the value using the given formatter.

impl<L: Default + LocationLike, Major: Default + Component> Default for Ordered<L, Major>

fn default() -> Ordered<L, Major>

Returns the "default value" for a type.

impl<L: LocationLike, M: Component> Deref for Ordered<L, M>

type Target = L

The resulting type after dereferencing.

#[must_use] fn deref(&self) -> &L

Dereferences the value.

impl<L: LocationLike, M: Component> DerefMut for Ordered<L, M>

#[must_use] fn deref_mut(&mut self) -> &mut L

Mutably dereferences the value.

impl<L: LocationLike, M: Component> Eq for Ordered<L, M>

impl<L: LocationLike, M: Component> From<L> for Ordered<L, M>

#[must_use] fn from(location: L) -> Self

Performs the conversion.

impl<L: Hash + LocationLike, Major: Hash + Component> Hash for Ordered<L, Major>

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<L: LocationLike, M: Component> LocationLike for Ordered<L, M>

#[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<L: LocationLike, M: Component> Ord for Ordered<L, M>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<L: LocationLike, M: Component, R: LocationLike> PartialEq<R> for Ordered<L, M>

#[must_use] fn eq(&self, rhs: &R) -> 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<L: LocationLike, M: Component> PartialOrd<Ordered<L, M>> for Ordered<L, M>

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

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

#[must_use] fn lt(&self, rhs: &Self) -> bool

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

#[must_use] fn le(&self, rhs: &Self) -> bool

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

#[must_use] fn gt(&self, rhs: &Self) -> bool

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

#[must_use] fn ge(&self, rhs: &Self) -> bool

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