Skip to main content

FixBuilder

Struct FixBuilder 

Source
pub struct FixBuilder { /* private fields */ }
Expand description

A VesselState under construction, built up one reading at a time.

Readings arrive as separate calls to its setters regardless of source – a Signal K delta, a parsed NMEA 0183 sentence, a replayed passage – and this type only tracks whether enough have arrived for a complete state. It has no knowledge of the source protocol.

Implementations§

Source§

impl FixBuilder

Source

pub fn new() -> Self

Nothing heard yet.

Source

pub fn set_position(&mut self, position: Position)

Records a position. Only a position update marks a fix as fresh; course and speed updates alone must not reset the age of a stalled position.

Source

pub fn set_course_over_ground(&mut self, deg: f64)

Records course over ground, degrees true.

Source

pub fn set_speed_over_ground(&mut self, kn: f64)

Records speed over ground, knots.

Source

pub fn set_heading(&mut self, deg: f64)

Records heading, degrees true. Never required – see VesselState::heading_deg.

Source

pub fn complete(self) -> Option<VesselState>

A complete state, if enough has arrived to build one.

Heading may be missing – a vessel without a compass has no heading line. Position, course and speed are required; there is no meaningful default for any of them.

Trait Implementations§

Source§

impl Clone for FixBuilder

Source§

fn clone(&self) -> FixBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FixBuilder

Source§

impl Debug for FixBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FixBuilder

Source§

fn default() -> FixBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.