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

A websocket message received from the client

Variants

ConnectionInit

Fields

payload: Option<Value>

Optional init payload from the client

A new connection

Start

Fields

id: String

Message ID

payload: Request

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

The start of a Websocket subscription

Stop

Fields

id: String

Message ID

The end of a Websocket subscription

ConnectionTerminate

Connection terminated by the client

Ping

Fields

payload: Option<Value>

Additional details about the ping.

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

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

Pong

Fields

payload: Option<Value>

Additional details about the pong.

The response to the Ping message.

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

Implementations

Creates a ClientMessage from an array of bytes

Trait Implementations

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Attaches the current Context to this type, returning a WithContext wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more