Enum Octal 

#[repr(C)]
pub enum Octal {
    East = 0,
    SouthEast = 1,
    South = 2,
    SouthWest = 3,
    West = 4,
    NorthWest = 5,
    North = 6,
    NorthEast = 7,
}

An octal (8-way) direction.

Variants

East = 0

SouthEast = 1

South = 2

SouthWest = 3

West = 4

NorthWest = 5

North = 6

NorthEast = 7

Implementations

impl Octal

pub const VARIANTS: [Self; 8]

All direction variants.

pub const NAMES: [&'static str; 8]

All direction names.

pub fn from_index(idx: usize) -> Option<Self>

Parse from a direction’s variant index.

pub fn to_str(self) -> &'static str

String representation of this direction.

pub fn from_str(s: &str) -> Option<Self>

Parse from a string representation, for example "East".

impl Octal

pub fn from_cardinal(dir: Cardinal) -> Self

Convert from a cardinal direction.

pub const fn rev(self) -> Self

Reverse the direction.

pub fn cw(self) -> Self

Returns the octal direction 45° clockwise of this one.

pub fn ccw(self) -> Self

Returns the octal direction 45° counter-clockwise of this one.

pub const fn grid_step<T: Signed>(self) -> Vec2<T>

Get the direction as an offset vector for a grid.

Trait Implementations

impl Clone for Octal

fn clone(&self) -> Octal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Octal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Octal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Float> Direction<T> for Octal

fn to_degrees(self) -> Degrees<T>

Angle of the direction in degrees.

fn to_radians(self) -> Radians<T>

Angle of the direction in radians.

fn to_rotations(self) -> Rotations<T>

Angle of the direction in rotations.

fn from_vec2(v: Vec2<T>) -> Self

The direction from the direction of a vector.

fn sin_cos(self) -> (T, T)

The (sin, cos) pair for this direction.

fn norm(self) -> Vec2<T>

Normal representation of this direction.

fn to_cardinal(self, bias: Cardinal) -> Cardinal

Get an approximately equivalent Cardinal direction.

fn to_octal(self) -> Octal

Get an approximately equivalent Octal direction.

impl Display for Octal

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

Formats the value using the given formatter.

impl From<Cardinal> for Octal

fn from(value: Cardinal) -> Self

Converts to this type from the input type.

impl<T: Float> From<Octal> for Degrees<T>

fn from(value: Octal) -> Self

Converts to this type from the input type.

impl<T: Float> From<Octal> for Radians<T>

fn from(value: Octal) -> Self

Converts to this type from the input type.

impl<T: Float> From<Octal> for Rotations<T>

fn from(value: Octal) -> Self

Converts to this type from the input type.

impl Hash for Octal

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 Ord for Octal

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

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

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

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 Octal

impl Eq for Octal

impl StructuralPartialEq for Octal