Enum WebsocketMessage 

pub enum WebsocketMessage {
    IncomingMessage(SmsMessage),
    OutgoingMessage(SmsMessage),
    DeliveryReport {
        message_id: i64,
        report: SmsPartialDeliveryReport,
    },
    ModemStatusUpdate {
        previous: ModemStatusUpdateState,
        current: ModemStatusUpdateState,
    },
    GnssPositionReport(PositionReport),
    WebsocketConnectionUpdate {
        connected: bool,
        reconnect: bool,
    },
}

WebSocket message types that can be received from the server.

Variants

IncomingMessage(SmsMessage)

New SMS message received.

OutgoingMessage(SmsMessage)

SMS message being sent from API or other connected client.

DeliveryReport

Delivery report update.

Fields

message_id: i64

The target message_id this delivery report applies to. This is determined from the message_reference and sender.

report: SmsPartialDeliveryReport

The received delivery report.

ModemStatusUpdate

Modem hat connection status update. This can be either: Startup, Online, ShuttingDown, Offline

Fields

previous: ModemStatusUpdateState

Previous state from last update.

current: ModemStatusUpdateState

Current state after update.

GnssPositionReport(PositionReport)

An unsolicited position report from GNSS.

WebsocketConnectionUpdate

WebSocket connection status update (client-side only). This message is generated locally when there is a connection or disconnection.

Fields

connected: bool

Connection status: true = connected, false = disconnected

reconnect: bool

If connection is false, will the client attempt to automatically reconnect?

Trait Implementations

impl Clone for WebsocketMessage

fn clone(&self) -> WebsocketMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebsocketMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebsocketMessage

fn eq(&self, other: &WebsocketMessage) -> 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 Serialize for WebsocketMessage

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 WebsocketMessage