Enum Direction

pub enum Direction {
    Left = -1,
    Right = 1,
    Stay = 0,
}

Direction enumerates the various directions a head can move, namely: left, right, and stay.

The included methods and implementations aim to streamline the conversion between Direction and other types.

Variants

Left = -1

Represents a single left shift

Right = 1

Represents a single right shift

Stay = 0

Represents no movement

Implementations

impl Direction

pub fn from_u8(value: u8) -> Self

Converts an instance of the named type into a Direction.

pub fn from_u16(value: u16) -> Self

Converts an instance of the named type into a Direction.

pub fn from_u32(value: u32) -> Self

Converts an instance of the named type into a Direction.

pub fn from_u64(value: u64) -> Self

Converts an instance of the named type into a Direction.

pub fn from_u128(value: u128) -> Self

Converts an instance of the named type into a Direction.

pub fn from_usize(value: usize) -> Self

Converts an instance of the named type into a Direction.

impl Direction

pub fn left() -> Self

pub fn right() -> Self

pub fn stay() -> Self

impl Direction

pub const fn is_left(&self) -> bool

Returns true if the enum is Direction::Left otherwise false

pub const fn is_right(&self) -> bool

Returns true if the enum is Direction::Right otherwise false

pub const fn is_stay(&self) -> bool

Returns true if the enum is Direction::Stay otherwise false

impl Direction

pub fn from_i8(value: i8) -> Self

Converts an i8 value into a Direction by taking the modulus of the value. The function uses a modulator of 2 to determine the direction since there are only two actionable directions (left and right).

pub fn from_char(value: char) -> Self

Converts a char value into a direction; matches the value to the corresponding direction.

pub fn from_str(value: &str) -> Self

Converts a str value into a Direction by matching the value to the corresponding variant; defaults to Stay if the value does not match accepted representations of neither left nor right.

pub fn as_char(&self) -> char

Returns a char representation of the direction.

standard char representation

‘L’ => Direction::Left ‘R’ => Direction::Right ‘S’ => Direction::Stay

pub fn as_str(&self) -> &str

Returns a str representation of the direction.

pub fn apply_unsigned(self, cur: usize) -> usize

Applies the shift to the given position in the direction specified by the current instance. This is done using the wrapping_add_signed method.

Trait Implementations

impl Add<Direction> for i128

type Output = i128

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for i16

type Output = i16

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for i32

type Output = i32

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for i64

type Output = i64

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for i8

type Output = i8

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for isize

type Output = isize

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for u128

type Output = u128

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for u16

type Output = u16

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for u32

type Output = u32

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for u64

type Output = u64

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for u8

type Output = u8

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl Add<Direction> for usize

type Output = usize

The resulting type after applying the + operator.

fn add(self, rhs: Direction) -> Self::Output

Performs the + operation.

impl<T> Add<T> for Direction

where T: Add<Output = T> + Sub<Output = T> + One,

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl AddAssign<Direction> for i128

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for i16

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for i32

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for i64

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for i8

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for isize

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for u128

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for u16

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for u32

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for u64

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for u8

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AddAssign<Direction> for usize

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl AsRef<str> for Direction

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Direction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Direction

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

Formats the value using the given formatter.

impl EnumCount for Direction

const COUNT: usize = 3usize

impl From<&str> for Direction

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<char> for Direction

fn from(value: char) -> Self

Converts to this type from the input type.

impl From<i128> for Direction

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Direction

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Direction

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Direction

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Direction

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Direction

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Direction

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Direction

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Direction

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Direction

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Direction

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Direction

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for Direction

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 IntoEnumIterator for Direction

type Iterator = DirectionIter

fn iter() -> DirectionIter

impl Ord for Direction

fn cmp(&self, other: &Direction) -> 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 PartialEq for Direction

fn eq(&self, other: &Direction) -> 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 PartialOrd for Direction

fn partial_cmp(&self, other: &Direction) -> 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 Serialize for Direction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl VariantArray for Direction

const VARIANTS: &'static [Self]

impl VariantNames for Direction

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction