Enum gardiz::axis::Axis

pub enum Axis {
    Y,
    X,
}

The axes of a plane.

Variants

Y

The Y axis (changes vertically).

X

The X axis (changes horizontally).

Implementations

impl Axis

pub const ALL: [Axis; 2] = _

List of all possible axes. Please note that this requires no heap-allocation and is very cheap.

pub fn iter() -> Iter

Iterator over all axes.

Examples

Note that these examples put the axes in a vector, but if you want an array of axes, just use Axis::ALL.

Default Order

use gardiz::axis::{self, Axis};

let axes: Vec<Axis> = Axis::iter().collect();
assert_eq!(vec![Axis::Y, Axis::X], axes);

Reverse Order

use gardiz::axis::{self, Axis};

let axes: Vec<Axis> = Axis::iter().rev().collect();
assert_eq!(vec![Axis::X, Axis::Y], axes);

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Axis

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

Deserialize this value from the given Serde deserializer.

impl Display for Axis

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

Formats the value using the given formatter.

impl Hash for Axis

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<Axis> for Vec2<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Axis> for Vec2<T>

fn index_mut(&mut self, axis: Axis) -> &mut Self::Output

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

impl Not for Axis

type Output = Axis

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Axis

fn cmp(&self, other: &Axis) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Axis> for Axis

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

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

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

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

impl PartialOrd<Axis> for Axis

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

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

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

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

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

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

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

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

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

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

impl Serialize for Axis

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

Serialize this value into the given Serde serializer.

impl Copy for Axis

impl Eq for Axis

impl StructuralEq for Axis

impl StructuralPartialEq for Axis