Struct SubscriptionsConfig 

#[non_exhaustive]
pub struct SubscriptionsConfig {
    pub websocket: Toggle,
    pub sse: Toggle,
    pub max_connections: usize,
    pub keepalive_secs: u64,
    pub init_timeout_secs: u64,
}

Subscriptions over WebSocket and Server-Sent Events.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

websocket: Toggle

Mount GET {path}/ws (graphql-transport-ws and legacy graphql-ws). auto = on when the schema has a subscription root.

sse: Toggle

Serve operations as text/event-stream when the client asks for it (GraphQL over SSE, “distinct connections” mode). auto = on when the schema has a subscription root.

max_connections: usize

Most concurrent WebSocket + SSE streams per endpoint; 0 = unlimited.

keepalive_secs: u64

Keep-alive interval, in seconds, for WebSocket pings and SSE comments.

init_timeout_secs: u64

Seconds a WebSocket client has to send connection_init before the server closes it with 4408.

Trait Implementations

impl Clone for SubscriptionsConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionsConfig

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

Formats the value using the given formatter.

impl Default for SubscriptionsConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionsConfig

where SubscriptionsConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SubscriptionsConfig

impl PartialEq for SubscriptionsConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SubscriptionsConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SubscriptionsConfig