Enum ferrostar::deviation_detection::RouteDeviationTracking

pub enum RouteDeviationTracking {
    None,
    StaticThreshold {
        minimum_horizontal_accuracy: u16,
        max_acceptable_deviation: f64,
    },
    Custom {
        detector: Arc<dyn RouteDeviationDetector>,
    },
}

Determines if the user has deviated from the expected route.

Variants

None

No checks will be done, and we assume the user is always following the route.

StaticThreshold

Uses a configurable static distance threshold to determine if the user has deviated from the route.

Fields

minimum_horizontal_accuracy: u16

The minimum required horizontal accuracy of the user location, in meters. Values larger than this will not trigger route deviation warnings.

max_acceptable_deviation: f64

The maximum acceptable deviation from the route line, in meters.

If the distance between the reported location and the expected route line is greater than this threshold, it will be flagged as an off route condition.

Custom

Arbitrary custom code; you decide!

Fields

detector: Arc<dyn RouteDeviationDetector>

Trait Implementations

impl Clone for RouteDeviationTracking

fn clone(&self) -> RouteDeviationTracking

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for RouteDeviationTracking

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

impl<T> FfiConverter<T> for RouteDeviationTracking

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.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a MetadataBuffer.

impl<UT> Lift<UT> for RouteDeviationTracking

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

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

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

const TYPE_ID_META: MetadataBuffer = _

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

Convenience method

impl<UT> LiftRef<UT> for RouteDeviationTracking

type LiftType = RouteDeviationTracking

impl<UT> LiftReturn<UT> for RouteDeviationTracking

fn lift_callback_return(buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method result

const TYPE_ID_META: MetadataBuffer = _

fn lift_callback_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 RouteDeviationTracking

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

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

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

const TYPE_ID_META: MetadataBuffer = _

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerReturn<UT> for RouteDeviationTracking

type ReturnType = <RouteDeviationTracking as Lower<UT>>::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