Enum ClientMessage 

pub enum ClientMessage {
    Authenticate {
        credentials: WsAuthCredentials,
        protocol: ProtocolOptions,
    },
    Subscribe {
        subscription: SubscriptionRequest,
    },
    NextBatch {
        subscription_id: String,
        last_seq_id: Option<SeqId>,
    },
    Unsubscribe {
        subscription_id: String,
    },
    Ping,
}

Client-to-server live query request messages.

Variants

Authenticate

Authenticate WebSocket connection.

Fields

credentials: WsAuthCredentials

protocol: ProtocolOptions

Subscribe

Subscribe to live query updates.

Fields

subscription: SubscriptionRequest

NextBatch

Request next batch of initial data.

Fields

subscription_id: String

last_seq_id: Option<SeqId>

Unsubscribe

Unsubscribe from live query.

Fields

subscription_id: String

Ping

Application-level keepalive ping.

Implementations

impl ClientMessage

pub fn subscribe(subscription: SubscriptionRequest) -> ClientMessage

Create a subscribe message for a single subscription.

pub fn next_batch( subscription_id: String, last_seq_id: Option<SeqId>, ) -> ClientMessage

Create a next batch request message.

pub fn unsubscribe(subscription_id: String) -> ClientMessage

Create an unsubscribe message.

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.