Enum ServerMessage

pub enum ServerMessage<S> {
    ConnectionError {
        payload: ConnectionErrorPayload,
    },
    ConnectionAck,
    Data {
        id: String,
        payload: DataPayload<S>,
    },
    Error {
        id: String,
        payload: ErrorPayload,
    },
    Complete {
        id: String,
    },
    ConnectionKeepAlive,
}

Available on crate feature graphql-ws only.

ServerMessage defines the message types that servers can send.

Variants

ConnectionError

ConnectionError is used for errors that are not associated with a GraphQL operation. For example, this will be used when:

• The server is unable to parse a client’s message.
• The client’s initialization parameters are rejected.

Fields

payload: ConnectionErrorPayload

The error that occurred.

ConnectionAck

ConnectionAck is sent in response to a client’s ConnectionInit message if the server accepted a connection.

Data

Data contains the result of a query, mutation, or subscription event.

Fields

id: String

The id of the operation that the data is for.

payload: DataPayload<S>

The data and errors that occurred during execution.

Error

Error contains an error that occurs before execution, such as validation errors.

Fields

id: String

The id of the operation that triggered this error.

payload: ErrorPayload

The error(s).

Complete

Complete indicates that no more data will be sent for the given operation.

Fields

id: String

The id of the operation that has completed.

ConnectionKeepAlive

ConnectionKeepAlive is sent periodically after accepting a connection.

Trait Implementations

impl<S: Debug> Debug for ServerMessage<S>

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

Formats the value using the given formatter.

impl<S: PartialEq> PartialEq for ServerMessage<S>

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

where S: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> StructuralPartialEq for ServerMessage<S>