Enum ferrostar::navigation_controller::models::StepAdvanceMode

pub enum StepAdvanceMode {
    Manual,
    DistanceToEndOfStep {
        distance: u16,
        minimum_horizontal_accuracy: u16,
    },
    RelativeLineStringDistance {
        minimum_horizontal_accuracy: u16,
        automatic_advance_distance: Option<u16>,
    },
}

Variants

Manual

Never advances to the next step automatically

DistanceToEndOfStep

Automatically advances when the user’s location is close enough to the end of the step

Fields

distance: u16

Distance to the last waypoint in the step, measured in meters, at which to advance.

minimum_horizontal_accuracy: u16

The minimum required horizontal accuracy of the user location, in meters. Values larger than this cannot trigger a step advance.

RelativeLineStringDistance

Automatically advances when the user’s distance to the next step’s linestring is less than the distance to the current step’s linestring.

Fields

minimum_horizontal_accuracy: u16

The minimum required horizontal accuracy of the user location, in meters. Values larger than this cannot trigger a step advance.

automatic_advance_distance: Option<u16>

At this (optional) distance, navigation should advance to the next step regardless of which LineString appears closer.

Trait Implementations

impl Clone for StepAdvanceMode

fn clone(&self) -> StepAdvanceMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for StepAdvanceMode

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

impl Debug for StepAdvanceMode

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

Formats the value using the given formatter.

impl<T> FfiConverter<T> for StepAdvanceMode

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 StepAdvanceMode

type FfiType = <StepAdvanceMode 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 StepAdvanceMode

type LiftType = StepAdvanceMode

impl<UT> LiftReturn<UT> for StepAdvanceMode

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 StepAdvanceMode

type FfiType = <StepAdvanceMode 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 StepAdvanceMode

type ReturnType = <StepAdvanceMode 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

impl Copy for StepAdvanceMode