Struct Depth 

pub struct Depth {
    pub metres: f64,
    pub reference: Sounding,
}

A sounding, and what it was measured from.

The reference travels with the number so that nothing downstream has to assume one. This is the same discipline a Raymarine, B&G or Garmin display keeps: the offset is stated once, the value is labelled, and an unconfigured installation reads out depth below the transducer rather than quietly claiming to be depth below the keel.

Fields

metres: f64

Metres. Signal K is already metric here, so nothing is converted.

reference: Sounding

What it is measured from.

Implementations

impl Depth

pub fn to(self, wanted: Sounding, offsets: Offsets) -> Option<Self>

The same sounding measured from somewhere else, if the geometry to get there is known.

None when it is not, and that is the whole point of the type. Guessing an offset – or worse, leaving it at zero and calling the result depth below the keel – reports more water than there is, by exactly the amount nobody stated. A depth display that does that is wrong in the one direction it must never be wrong in.

A negative result is not an error and is not clamped: it means the keel is already in the bottom, which is worth showing.

Trait Implementations

impl Clone for Depth

fn clone(&self) -> Depth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Depth

impl Debug for Depth

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

Formats the value using the given formatter.

impl PartialEq for Depth

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