Struct ForecastedEvent 

#[non_exhaustive]
pub struct ForecastedEvent {
    pub event_id: String,
    pub geofence_id: String,
    pub is_device_in_geofence: bool,
    pub nearest_distance: f64,
    pub event_type: ForecastedGeofenceEventType,
    pub forecasted_breach_time: Option<DateTime>,
    pub geofence_properties: Option<HashMap<String, String>>,
}

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

event_id: String

The forecasted event identifier.

geofence_id: String

The geofence identifier pertaining to the forecasted event.

is_device_in_geofence: bool

Indicates if the device is located within the geofence.

nearest_distance: f64

The closest distance from the device's position to the geofence.

event_type: ForecastedGeofenceEventType

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

forecasted_breach_time: Option<DateTime>

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofence_properties: Option<HashMap<String, String>>

The geofence properties.

Implementations

impl ForecastedEvent

pub fn event_id(&self) -> &str

The forecasted event identifier.

pub fn geofence_id(&self) -> &str

The geofence identifier pertaining to the forecasted event.

pub fn is_device_in_geofence(&self) -> bool

Indicates if the device is located within the geofence.

pub fn nearest_distance(&self) -> f64

The closest distance from the device's position to the geofence.

pub fn event_type(&self) -> &ForecastedGeofenceEventType

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

pub fn forecasted_breach_time(&self) -> Option<&DateTime>

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

pub fn geofence_properties(&self) -> Option<&HashMap<String, String>>

The geofence properties.

impl ForecastedEvent

pub fn builder() -> ForecastedEventBuilder

Creates a new builder-style object to manufacture ForecastedEvent.

Trait Implementations

impl Clone for ForecastedEvent

fn clone(&self) -> ForecastedEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForecastedEvent

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

Formats the value using the given formatter.

impl PartialEq for ForecastedEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ForecastedEvent