Struct Angle 

pub struct Angle(/* private fields */);

An angle, as a fraction of a turn.

Contract

• A full turn is 2³² units, so arithmetic wraps exactly and an angle is always in range by construction. There is no normalisation step and no way to hold an out-of-range angle.
• Ord follows the underlying bits, which orders angles by their position in a turn starting from zero — not by “smallest rotation”, which is not a total order.

Implementations

impl Angle

pub const ZERO: Self

No rotation.

pub const QUARTER: Self

A quarter turn: 90 degrees.

pub const HALF: Self

A half turn: 180 degrees.

pub const THREE_QUARTERS: Self

Three quarters of a turn: 270 degrees.

pub const fn from_bits(bits: u32) -> Self

From raw binary-angle units.

pub const fn to_bits(self) -> u32

The raw units.

pub const fn from_degrees(degrees: i32) -> Self

From degrees, exactly for the ones that divide a turn evenly.

Wrapping, so 370 degrees is 10 and −90 is 270 — which is the whole point of the representation rather than a convenience.

pub const fn from_turn_ratio(numerator: i32, denominator: i32) -> Self

From a fraction of a turn: from_turn_ratio(1, 8) is 45 degrees.

Panics

If denominator is zero.

pub fn sin(self) -> Fixed

The sine.

pub fn cos(self) -> Fixed

The cosine, which is the sine a quarter turn ahead.

pub fn sin_cos(self) -> (Fixed, Fixed)

Both, for callers that need them together — which is every rotation.

Trait Implementations

impl Add for Angle

fn add(self, other: Self) -> Self

Wrapping, which is exact: a full turn is the identity.

type Output = Angle

The resulting type after applying the + operator.

impl Clone for Angle

fn clone(&self) -> Angle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Angle

impl Debug for Angle

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

Formats the value using the given formatter.

impl Default for Angle

fn default() -> Angle

Returns the “default value” for a type.

impl Eq for Angle

impl Hash for Angle

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 Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Angle

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Angle

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

impl Sub for Angle

fn sub(self, other: Self) -> Self

Wrapping, which is exact.

type Output = Angle

The resulting type after applying the - operator.