Enum juniper_graphql_ws::ClientMessage

pub enum ClientMessage<S: ScalarValue> {
    ConnectionInit {
        payload: Variables<S>,
    },
    Start {
        id: String,
        payload: StartPayload<S>,
    },
    Stop {
        id: String,
    },
    ConnectionTerminate,
}

ClientMessage defines the message types that clients can send.

Variants

ConnectionInit

ConnectionInit is sent by the client upon connecting.

Fields of ConnectionInit

payload: Variables<S>

Optional parameters of any type sent from the client. These are often used for authentication.

Start

Start messages are used to execute a GraphQL operation.

Fields of Start

id: String

The id of the operation. This can be anything, but must be unique. If there are other in-flight operations with the same id, the message will be ignored or cause an error.

payload: StartPayload<S>

The query, variables, and operation name.

Stop

Stop messages are used to unsubscribe from a subscription.

Fields of Stop

id: String

The id of the operation to stop.

ConnectionTerminate

ConnectionTerminate is used to terminate the connection.

Trait Implementations

impl<S: Debug + ScalarValue> Debug for ClientMessage<S>

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

Formats the value using the given formatter.

impl<'de, S: ScalarValue> Deserialize<'de> for ClientMessage<S> where
    S: ScalarValue, 

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

Deserialize this value from the given Serde deserializer.

impl<S: PartialEq + ScalarValue> PartialEq<ClientMessage<S>> for ClientMessage<S>

fn eq(&self, other: &ClientMessage<S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ClientMessage<S>) -> bool

This method tests for !=.

impl<S: ScalarValue> StructuralPartialEq for ClientMessage<S>