Enum Cardinal

#[repr(u16)]
pub enum Cardinal {
    North = 0,
    NorthEast = 45,
    East = 90,
    SouthEast = 135,
    South = 180,
    SouthWest = 225,
    West = 270,
    NorthWest = 315,
}

Variants

North = 0

Northern Cardinal

NorthEast = 45

North Eastern Cardinal

East = 90

Eastern Cardinal

SouthEast = 135

South Eastern Cardinal

South = 180

Southern Cardinal

SouthWest = 225

South Western Cardinal

West = 270

Western Cardinal

NorthWest = 315

North Western Cardinal

Implementations

impl Cardinal

pub fn is_latitude(&self) -> bool

Returns True if Self matches a latitude cardinal

pub fn is_longitude(&self) -> bool

Returns True if Self matches a longitude cardinal

pub fn same_kind(&self, rhs: Self) -> bool

Returns True if Cardinal and rhs represents same kind of coordinates

pub fn is_northern(&self) -> bool

Returns True if Self is a Northern cardinal

pub fn is_southern(&self) -> bool

Returns True if Self is a Southern cardinal

pub fn is_eastern(&self) -> bool

Returns True if Self is an Eastern cardinal

pub fn is_western(&self) -> bool

Returns True if Self is a Western cardinal

pub fn is_sub_quadrant(&self) -> bool

Returns True if Self matches a subquadrant cardinal, like NE or SW

pub fn to_angle(&self) -> u16

Returns compass angle (in D°) associated to Self, 0° being North Cardinal

pub fn from_angle(angle: u16) -> Cardinal

Builds a Cardinal from given compass angle (in D°), 0° being North Cardinal

Trait Implementations

impl Add<u16> for Cardinal

fn add(self, rhs: u16) -> Self

Adds given angle (°) to Self

type Output = Cardinal

The resulting type after applying the + operator.

impl Clone for Cardinal

fn clone(&self) -> Cardinal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cardinal

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

Formats the value using the given formatter.

impl Default for Cardinal

fn default() -> Self

Builds default Northern Cardinal

impl Display for Cardinal

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

Formats the value using the given formatter.

impl PartialEq for Cardinal

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

impl Eq for Cardinal

impl StructuralPartialEq for Cardinal