Enum RouteDeviation 

pub enum RouteDeviation {
    NoDeviation,
    Deviation {
        kind: DeviationKind,
    },
}

Status information that describes whether the user is proceeding according to the route or not.

Note that the name is intentionally a bit generic to allow for expansion of other states. For example, we could conceivably add a “wrong way” status in the future.

Variants

NoDeviation

The user is proceeding on course within the expected tolerances; everything is normal.

Deviation

The user has deviated from the expected route.

Check the DeviationKind to determine if the user is still on the route polyline (off the current step but on a future step) or off the route entirely.

Fields

kind: DeviationKind

Implementations

impl RouteDeviation

pub fn is_deviated_from_current_step(&self) -> bool

Whether the user is no longer on the current step’s polyline.

This can happen either because the user has moved onto a future step without triggering advance, or because they have left the route entirely. In other words: any deviation from the current step.

pub fn is_completely_off_route(&self) -> bool

Whether the user has deviated from the route entirely.

This is true when the user is not just deviated from the current step, but also from the route as a whole (they didn’t just take a shortcut).

Trait Implementations

impl Clone for RouteDeviation

fn clone(&self) -> RouteDeviation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for RouteDeviation

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Copy for RouteDeviation

impl Debug for RouteDeviation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RouteDeviation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for RouteDeviation

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for RouteDeviation

type FfiType = <RouteDeviation as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for RouteDeviation

type LiftType = RouteDeviation

impl<UT> LiftReturn<UT> for RouteDeviation

type ReturnType = <RouteDeviation as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for RouteDeviation

type FfiType = <RouteDeviation as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for RouteDeviation

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RouteDeviation

type ReturnType = <RouteDeviation as Lower<UT>>::FfiType

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

fn lower_return(v: 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 PartialEq for RouteDeviation

fn eq(&self, other: &RouteDeviation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RouteDeviation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RouteDeviation

impl<UT> TypeId<UT> for RouteDeviation

const TYPE_ID_META: MetadataBuffer