Struct DirectionsSet 

pub struct DirectionsSet(/* private fields */);

Immutable Set of Direction with small memory footprint.

Can be used as key representing some aggregated quality of game board position. For example, in puzzle:

#####
#@  #
#$  #
#.  #
#####

we can see that position (0, 0) is a wall that has neighbor wall on the right and below. Or, in terms of DirectionsSet:

use sokoban_elements::*;

let neighbor_walls: DirectionsSet = [Direction::Left, Direction::Up].into();

assert_eq!(neighbor_walls, [Direction::Left, Direction::Up]);

assert!(neighbor_walls.contains(Direction::Left));
assert!(neighbor_walls.contains(Direction::Up));

assert!(!neighbor_walls.contains(Direction::Down));

Implementations

impl DirectionsSet

pub fn is_empty(&self) -> bool

pub fn contains(&self, direction: Direction) -> bool

pub fn iter(&self) -> DirectionsSetIter

Trait Implementations

impl Clone for DirectionsSet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DirectionsSet

impl Debug for DirectionsSet

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

Formats the value using the given formatter.

impl Default for DirectionsSet

fn default() -> Self

Returns the “default value” for a type.

impl Display for DirectionsSet

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

Formats the value using the given formatter.

impl Eq for DirectionsSet

impl<const N: usize> From<&[Direction; N]> for DirectionsSet

fn from(data: &[Direction; N]) -> Self

Converts to this type from the input type.

impl From<&[Direction]> for DirectionsSet

fn from(data: &[Direction]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&mut [Direction; N]> for DirectionsSet

fn from(data: &mut [Direction; N]) -> Self

Converts to this type from the input type.

impl From<&mut [Direction]> for DirectionsSet

fn from(data: &mut [Direction]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[Direction; N]> for DirectionsSet

fn from(data: [Direction; N]) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a Direction> for DirectionsSet

fn from_iter<I: IntoIterator<Item = &'a Direction>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<&'a mut Direction> for DirectionsSet

fn from_iter<I: IntoIterator<Item = &'a mut Direction>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Direction> for DirectionsSet

fn from_iter<I: IntoIterator<Item = Direction>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for DirectionsSet

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 IntoIterator for &DirectionsSet

type Item = Direction

The type of the elements being iterated over.

type IntoIter = DirectionsSetIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for DirectionsSet

type Item = Direction

The type of the elements being iterated over.

type IntoIter = DirectionsSetIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for DirectionsSet

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for DirectionsSet

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<&[Direction; N]> for DirectionsSet

fn eq(&self, other: &&[Direction; N]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&[Direction]> for DirectionsSet

fn eq(&self, other: &&[Direction]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<&mut [Direction; N]> for DirectionsSet

fn eq(&self, other: &&mut [Direction; N]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&mut [Direction]> for DirectionsSet

fn eq(&self, other: &&mut [Direction]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<DirectionsSet> for [Direction; N]

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<DirectionsSet> for &[Direction; N]

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<DirectionsSet> for &mut [Direction; N]

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DirectionsSet> for [Direction]

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DirectionsSet> for &[Direction]

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DirectionsSet> for &mut [Direction]

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

Equality operator ==.

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

Inequality operator !=.

impl<const N: usize> PartialEq<[Direction; N]> for DirectionsSet

fn eq(&self, other: &[Direction; N]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<[Direction]> for DirectionsSet

fn eq(&self, other: &[Direction]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DirectionsSet

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for DirectionsSet