Struct ServerMessage 

pub struct ServerMessage {
    pub message_type: String,
    pub id: Option<String>,
    pub payload: Option<Value>,
}

Server message (to WebSocket client).

Fields

message_type: String

Message type.

id: Option<String>

Operation ID (for next/error/complete).

payload: Option<Value>

Payload (data, errors, or ack payload).

Implementations

impl ServerMessage

pub fn connection_ack(payload: Option<Value>) -> Self

Create connection_ack message.

pub fn ping(payload: Option<Value>) -> Self

Create ping message.

pub fn pong(payload: Option<Value>) -> Self

Create pong message.

pub fn next(id: impl Into<String>, data: Value) -> Self

Create next (data) message.

pub fn next_with_extensions( id: impl Into<String>, data: Value, extensions: Value, ) -> Self

Create a next (data) message that also carries GraphQL extensions.

Mirrors Self::next but populates the extensions field of the graphql-transport-ws ExecutionResult payload — the spec-blessed, safely-ignorable slot used to deliver the Change-Spine envelope to subscription clients (#425).

pub fn error(id: impl Into<String>, errors: Vec<GraphQLError>) -> Self

Create error message.

pub fn complete(id: impl Into<String>) -> Self

Create complete message.

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON string.

Errors

Returns error if serialization fails.

Trait Implementations

impl Clone for ServerMessage

fn clone(&self) -> ServerMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerMessage

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

Formats the value using the given formatter.

impl Serialize for ServerMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.