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.Expand description
ServerMessage defines the message types that servers can send.
Variants§
ConnectionError
Fields
§
payload: ConnectionErrorPayload
The error that occurred.
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.
ConnectionAck
ConnectionAck is sent in response to a client’s ConnectionInit message if the server accepted a connection.
Data
Fields
§
payload: DataPayload<S>
The data and errors that occurred during execution.
Data contains the result of a query, mutation, or subscription event.
Error
Fields
§
payload: ErrorPayload
The error(s).
Error contains an error that occurs before execution, such as validation errors.
Complete
Complete indicates that no more data will be sent for the given operation.
ConnectionKeepAlive
ConnectionKeepAlive is sent periodically after accepting a connection.
Trait Implementations§
source§impl<S: Debug> Debug for ServerMessage<S>
impl<S: Debug> Debug for ServerMessage<S>
source§impl<S: PartialEq> PartialEq for ServerMessage<S>
impl<S: PartialEq> PartialEq for ServerMessage<S>
source§fn eq(&self, other: &ServerMessage<S>) -> bool
fn eq(&self, other: &ServerMessage<S>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<S> Serialize for ServerMessage<S>where
S: Serialize,
impl<S> Serialize for ServerMessage<S>where
S: Serialize,
impl<S> StructuralPartialEq for ServerMessage<S>
Auto Trait Implementations§
impl<S> Freeze for ServerMessage<S>where
S: Freeze,
impl<S> !RefUnwindSafe for ServerMessage<S>
impl<S> Send for ServerMessage<S>where
S: Send,
impl<S> !Sync for ServerMessage<S>
impl<S> !Unpin for ServerMessage<S>
impl<S> !UnwindSafe for ServerMessage<S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more