Enum WsProtocol 

#[non_exhaustive]
pub enum WsProtocol {
    GraphqlTransportWs,
    GraphqlWs,
}

Supported WebSocket sub-protocols for GraphQL subscriptions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GraphqlTransportWs

Modern graphql-transport-ws protocol (enisdenjo/graphql-ws).

Message types: connection_init, connection_ack, ping, pong, subscribe, next, error, complete.

GraphqlWs

Legacy graphql-ws protocol (Apollo subscriptions-transport-ws).

Message types: connection_init, connection_ack, start, data, error, stop, complete, ka (keepalive).

Implementations

impl WsProtocol

pub fn from_header(header: Option<&str>) -> Option<Self>

Parse the Sec-WebSocket-Protocol header value to select a protocol.

The header may contain multiple comma-separated values; the first recognised protocol wins. Returns None if no known protocol is found.

pub const fn as_str(self) -> &'static str

The protocol name to echo back in the WebSocket upgrade response.

Trait Implementations

impl Clone for WsProtocol

fn clone(&self) -> WsProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsProtocol

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

Formats the value using the given formatter.

impl PartialEq for WsProtocol

fn eq(&self, other: &WsProtocol) -> 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 Copy for WsProtocol

impl Eq for WsProtocol

impl StructuralPartialEq for WsProtocol