Struct Distance 

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

Distance, stored in nautical miles.

Signed: e.g. along-track distance is negative before the start of a leg. Functions requiring a positive distance check it.

Implementations

impl Distance

pub const ZERO: Self

Zero.

pub fn from_nautical_miles(value: f64) -> Result<Self>

From nautical miles.

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_cables(value: f64) -> Result<Self>

From cables (10 per NM).

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_metres(value: f64) -> Result<Self>

From metres.

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_kilometres(value: f64) -> Result<Self>

From kilometres.

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_feet(value: f64) -> Result<Self>

From feet (e.g. charted heights of lights).

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_fathoms(value: f64) -> Result<Self>

From fathoms.

Errors

KernelError::NotFinite for NaN or infinity.

pub fn from_arc_minutes(value: f64) -> Result<Self>

From minutes of arc of a great circle (1′ = 1 NM).

Errors

KernelError::NotFinite for NaN or infinity.

pub const fn nautical_miles(self) -> f64

Nautical miles.

pub fn cables(self) -> f64

Cables.

pub fn metres(self) -> f64

Metres.

pub fn kilometres(self) -> f64

Kilometres.

pub fn feet(self) -> f64

Feet.

pub fn abs(self) -> Self

Absolute value.

pub fn is_negative(self) -> bool

Whether negative.

pub fn time_at(self, speed: Speed) -> Result<Duration>

Time to cover this distance at speed.

Errors

KernelError::Indeterminate if the speed is zero or of opposite sign.

Trait Implementations

impl Add for Distance

type Output = Distance

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Distance

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 Distance

impl Debug for Distance

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

Formats the value using the given formatter.

impl Default for Distance

fn default() -> Self

Returns the “default value” for a type.

impl Display for Distance

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

Formats in nautical miles: 12.0 M.

impl Div<f64> for Distance

type Output = Distance

The resulting type after applying the / operator.

fn div(self, divisor: f64) -> Self

Performs the / operation.

impl Mul<f64> for Distance

type Output = Distance

The resulting type after applying the * operator.

fn mul(self, factor: f64) -> Self

Performs the * operation.

impl Neg for Distance

type Output = Distance

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Distance

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Distance

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 Distance

impl Sub for Distance

type Output = Distance

The resulting type after applying the - operator.

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

Performs the - operation.

impl VectorUnit for Distance

fn si(self) -> f64

Value in SI.

fn from_si(value: f64) -> Self

From an SI value known to be finite.