Struct NavigationController

pub struct NavigationController { /* private fields */ }

Manages the navigation lifecycle through a route, returning an updated state given inputs like user location.

Notes for implementing a new platform:

• A controller is bound to a single route; if you want recalculation, create a new instance.
• This is a pure type (no interior mutability), so a core function of your platform code is responsibly managing mutable state.

Implementations

impl NavigationController

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

Create a navigation controller for a route and configuration.

Trait Implementations

impl<UT> LiftRef<UT> for NavigationController

type LiftType = Arc<NavigationController>

impl<UT> LowerError<UT> for NavigationController

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for NavigationController

type ReturnType = <Arc<NavigationController> as LowerReturn<UniFfiTag>>::ReturnType

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

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

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Navigator for NavigationController

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

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

fn advance_to_next_step(&self, state: NavState) -> NavState

Advances navigation to the next step (or finishes the route).

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.

This method takes the intermediate state (e.g., from update_user_location) and advances if necessary, and does not handle anything like snapping.

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

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

Panics

If there is no current step (TripState::Navigating has an empty remainingSteps value), this function will panic.

impl<UT> TypeId<UT> for NavigationController

const TYPE_ID_META: MetadataBuffer