Enum LinearDirection

pub enum LinearDirection {
    Forward = 1,
    Backward = -1,
    Stay = 0,
}

The LinearDirection implementation enumerates the three pssoible movements in one-dimensional space, namely:

• Forward - the positive direction
• Backward - the negative direction
• Stay - no movement

Variants

Forward = 1

Backward = -1

Stay = 0

Implementations

impl LinearDirection

pub const fn is_forward(&self) -> bool

Returns true if the enum is LinearDirection::Forward otherwise false

pub const fn is_backward(&self) -> bool

Returns true if the enum is LinearDirection::Backward otherwise false

pub const fn is_stay(&self) -> bool

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

impl LinearDirection

pub fn from_isize(value: isize) -> Self

pub const fn backward() -> Self

a functional method for initializing a new backward variant

pub const fn stay() -> Self

a functional method for initializing a new stay variant

pub const fn forward() -> Self

a functional method for initializing a new forward variant

pub fn invert(self) -> Self

invert the current direction;

• Forward becomes Backward
• Backward becomes Forward
• Stay remains as is

Trait Implementations

impl AsRef<str> for LinearDirection

fn as_ref(&self) -> &str

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

impl Clone for LinearDirection

fn clone(&self) -> LinearDirection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinearDirection

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

Formats the value using the given formatter.

impl Default for LinearDirection

fn default() -> LinearDirection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LinearDirection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LinearDirection

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

Formats the value using the given formatter.

impl EnumCount for LinearDirection

const COUNT: usize = 3usize

impl FromStr for LinearDirection

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LinearDirection, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for LinearDirection

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 LinearDirection

type Iterator = LinearDirectionIter

fn iter() -> LinearDirectionIter

impl Ord for LinearDirection

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

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

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

const 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 LinearDirection

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for LinearDirection

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<LinearDirection, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantNames for LinearDirection

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

Names of the variants of this enum

impl Copy for LinearDirection

impl Eq for LinearDirection

impl StructuralPartialEq for LinearDirection