Struct CardinalValues

pub struct CardinalValues<T> {
    pub east: T,
    pub north: T,
    pub west: T,
    pub south: T,
}

A struct which a value assigned to each cardinal. This can be used as a shorthand for accessing arrays.

Fields

east: T

The value assigned to east.

north: T

The value assigned to north.

west: T

The value assigned to west.

south: T

The value assigned to south.

Implementations

impl<T> CardinalValues<T>

pub fn map<B, F>(self, f: F) -> CardinalValues<B>

where F: FnMut(T) -> B,

Converts a CardinalValues from one type to another.

Trait Implementations

impl<T: Clone> Clone for CardinalValues<T>

fn clone(&self) -> CardinalValues<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CardinalValues<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for CardinalValues<T>

fn default() -> CardinalValues<T>

Returns the “default value” for a type.

impl<T: Hash> Hash for CardinalValues<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<Cardinal> for CardinalValues<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Cardinal) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Copy> IntoIterator for CardinalValues<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = CardinalIterator<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for CardinalValues<T>

fn cmp(&self, other: &CardinalValues<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for CardinalValues<T>

fn eq(&self, other: &CardinalValues<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for CardinalValues<T>

fn partial_cmp(&self, other: &CardinalValues<T>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T: Copy> Copy for CardinalValues<T>

impl<T: Eq> Eq for CardinalValues<T>

impl<T> StructuralPartialEq for CardinalValues<T>