Struct ferrostar::navigation_controller::NavigationController

pub struct NavigationController { /* private fields */ }

Manages the navigation lifecycle of a route, reacting to inputs like user location updates and returning a new state. If you want to recalculate a new route, you need to create a new navigation controller.

In the overall architecture, this is a mid-level construct. It wraps some lower level constructs like the route adapter, but a higher level wrapper handles things like feeding in user location updates, route recalculation behavior, etc.

Implementations

impl NavigationController

pub fn new(route: Route, config: NavigationControllerConfig) -> Self

pub fn get_initial_state(&self, location: UserLocation) -> TripState

Returns initial trip state as if the user had just started the route with no progress.

pub fn advance_to_next_step(&self, state: &TripState) -> TripState

Advances navigation to the next step.

Depending on the advancement strategy, this may be automatic. For other cases, it is desirable to advance to the next step manually (ex: walking in an urban tunnel). We leave this decision to the app developer and provide this as a convenience.

pub fn update_user_location( &self, location: UserLocation, state: &TripState ) -> TripState

Updates the user’s current location and updates the navigation state accordingly.

Trait Implementations

impl<T> LiftRef<T> for NavigationController

type LiftType = Arc<NavigationController>

impl<T> LowerReturn<T> for NavigationController

type ReturnType = <NavigationController as FfiConverterArc<UniFfiTag>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

const TYPE_ID_META: MetadataBuffer = _

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts