Enum CardinalPoint 

#[non_exhaustive]
pub enum CardinalPoint {
    N,
    NE,
    E,
    SE,
    S,
    SW,
    W,
    NW,
}

Cardinal or intercardinal compass point.

A type rather than a string, so deviation-table points cannot be misspelled: a typo is a compile error, or KernelError::UnknownCardinalDirection when parsed, never a silent failed lookup.

#[non_exhaustive]; match with a wildcard arm.

Example

use kinavis_kernel::{CardinalPoint, CompassCourse};

assert_eq!(CardinalPoint::SW.degrees(), 225.0);
assert_eq!("sw".parse::<CardinalPoint>()?, CardinalPoint::SW);
assert_eq!(CompassCourse::from(CardinalPoint::SW).degrees(), 225.0);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

N

North, 000°.

NE

North-east, 045°.

E

East, 090°.

SE

South-east, 135°.

S

South, 180°.

SW

South-west, 225°.

W

West, 270°.

NW

North-west, 315°.

Implementations

impl CardinalPoint

pub const ALL: [Self; 8]

All eight points, N to NW.

pub const fn whole_degrees(self) -> i32

Course of the point in whole degrees, 0..360.

The points fall on multiples of 45°, and deviation tables are indexed by whole degrees.

pub fn degrees(self) -> f64

Course of the point in degrees, [0.0, 360.0).

pub const fn abbreviation(self) -> &'static str

Abbreviation, "N" to "NW".

Trait Implementations

impl Clone for CardinalPoint

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 CardinalPoint

impl Debug for CardinalPoint

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

Formats the value using the given formatter.

impl Default for CardinalPoint

fn default() -> Self

Returns the “default value” for a type.

impl Display for CardinalPoint

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

Formats the value using the given formatter.

impl Eq for CardinalPoint

impl<F: Frame> From<CardinalPoint> for Direction<F>

fn from(point: CardinalPoint) -> Self

The point as a direction in any frame; the point itself has no frame.

impl FromStr for CardinalPoint

fn from_str(text: &str) -> Result<Self>

Parses an abbreviation, case-insensitive, trimming whitespace.

Errors

KernelError::UnknownCardinalDirection for anything else.

type Err = KernelError

The associated error which can be returned from parsing.

impl Hash for CardinalPoint

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 CardinalPoint

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 CardinalPoint

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CardinalPoint

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 CardinalPoint