Enum ClientMessage

pub enum ClientMessage {
    ConnectionInit {
        payload: Option<Value>,
    },
    Start {
        id: String,
        payload: Request,
    },
    Stop {
        id: String,
    },
    ConnectionTerminate,
    Ping {
        payload: Option<Value>,
    },
    Pong {
        payload: Option<Value>,
    },
}

A websocket message received from the client

Variants

ConnectionInit

A new connection

Fields

payload: Option<Value>

Optional init payload from the client

Start

The start of a Websocket subscription

Fields

id: String

Message ID

payload: Request

The GraphQL Request - this can be modified by protocol implementors to add files uploads.

Stop

The end of a Websocket subscription

Fields

id: String

Message ID

ConnectionTerminate

Connection terminated by the client

Ping

Useful for detecting failed connections, displaying latency metrics or other types of network probing.

Reference: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md#ping

Fields

payload: Option<Value>

Additional details about the ping.

Pong

The response to the Ping message.

Reference: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md#pong

Fields

payload: Option<Value>

Additional details about the pong.

Implementations

impl ClientMessage

pub fn from_bytes<T>(message: T) -> Result<Self>

where T: AsRef<[u8]>,

Creates a ClientMessage from an array of bytes

Trait Implementations

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.