Skip to main content

Crate navcore_routes

Crate navcore_routes 

Source
Expand description

Routes, kept where every client can reach them.

A route is an ordered plan through several positions. A standalone waypoint (waypoints) is one place independent of any route; the two are siblings, not one a part of the other. This is the only crate that manages, publishes and loads routes: every client is meant to call the functions here rather than each holding a second copy of this logic.

This crate keeps no local copy of a route – see signalk’s own doc for why. A Route value exists here only as long as it takes to hand it to or read it from signalk; there is no database, no cache, and nothing to go stale.

Re-exports§

pub use plan::Route;
pub use plan::Waypoint;

Modules§

plan
What a route is, before any question of where it lives.
signalk
Signal K is the single source of truth for crate::Route. This module is not a sync backend but the only backend – see waypoints::signalk’s own doc for the fuller reasoning, including the callback-shaped spawn_* functions.