Struct beehive::DirectionMap

pub struct DirectionMap<T> { /* fields omitted */ }

A stack-allocated map backed by an array that can be indexed by Direction.

This type is only available with the collections feature.

Methods

impl<T: Default> DirectionMap<T>

pub fn new() -> Self

impl<T> DirectionMap<T>

pub fn from_array(arr: [T; 8]) -> Self

Create a DirectionMap from an array.

pub fn into_array(self) -> [T; 8]

Returns the underlying array in this DirectionMap.

pub fn as_array(&self) -> &[T; 8]

Returns a reference to the underlying array.

pub fn as_mut_array(&mut self) -> &mut [T; 8]

Returns a mutable reference to the underlying array.

pub fn as_slice(&self) -> &[T]

Returns a reference to the underlying array as a slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable reference to the underlying array as a slice.

pub fn get(&self, dir: Direction) -> &T

Returns a reference to the value corresponding to dir.

pub fn get_mut(&mut self, dir: Direction) -> &mut T

Returns a mutable reference to the value corresponding to dir.

pub fn with_initializer<F>(op: F) -> Self where
    F: FnMut(Direction) -> T, 

Construct a DirectionMap<T> with values provided from a FnMut(Direction) -> T.

Trait Implementations

impl<T: Clone> Clone for DirectionMap<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for DirectionMap<T>

impl<T: Debug> Debug for DirectionMap<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for DirectionMap<T>

fn default() -> DirectionMap<T>

Returns the "default value" for a type.

impl<'de, T> Deserialize<'de> for DirectionMap<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for DirectionMap<T>

impl<T: Hash> Hash for DirectionMap<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, 

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

impl<T> Index<Direction> for DirectionMap<T>

type Output = T

The returned type after indexing.

fn index(&self, d: Direction) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Direction> for DirectionMap<T>

fn index_mut(&mut self, d: Direction) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: Ord> Ord for DirectionMap<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<DirectionMap<T>> for DirectionMap<T>

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

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

fn ne(&self, other: &DirectionMap<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<DirectionMap<T>> for DirectionMap<T>

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

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

fn lt(&self, other: &DirectionMap<T>) -> bool

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

fn le(&self, other: &DirectionMap<T>) -> bool

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

fn gt(&self, other: &DirectionMap<T>) -> bool

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

fn ge(&self, other: &DirectionMap<T>) -> bool

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

impl<T> Serialize for DirectionMap<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for DirectionMap<T>

impl<T> StructuralPartialEq for DirectionMap<T>