Struct GraphQLSubscription 

pub struct GraphQLSubscription<E, OnConnInit = DefaultOnConnInitType, OnPing = DefaultOnPingType>
where
    E: Executor,
{ /* private fields */ }

Available on crate feature async-graphql only.

GraphQL WebSocket subscription responder (GraphQL over WebSocket).

Usage in a handler:

let schema = Schema::build(QueryRoot, MutationRoot, SubscriptionRoot).finish();
router.route(Method::GET, "/ws", move |req: Request| {
    let schema = schema.clone();
    async move { GraphQLSubscription::new(req, schema) }
});

Implementations

impl<E> GraphQLSubscription<E, DefaultOnConnInitType, DefaultOnPingType>

where E: Executor,

pub fn new(request: Request, executor: E) -> Self

impl<E, OnConnInit, OnPing> GraphQLSubscription<E, OnConnInit, OnPing>

where E: Executor,

pub fn with_data(self, data: Data) -> Self

pub fn keepalive_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

pub fn on_connection_init<F, Fut>( self, f: F, ) -> GraphQLSubscription<E, F, OnPing>

where F: FnOnce(Value) -> Fut + Send + 'static, Fut: Future<Output = GqlResult<Data>> + Send + 'static,

pub fn on_ping<F, Fut>(self, f: F) -> GraphQLSubscription<E, OnConnInit, F>

where F: FnOnce(Option<&Data>, Option<Value>) -> Fut + Clone + Send + 'static, Fut: Future<Output = GqlResult<Option<Value>>> + Send + 'static,

Trait Implementations

impl<E, OnConnInit, OnConnInitFut, OnPing, OnPingFut> Responder for GraphQLSubscription<E, OnConnInit, OnPing>

where E: Executor + Send + Sync + Clone + 'static, OnConnInit: FnOnce(Value) -> OnConnInitFut + Send + 'static, OnConnInitFut: Future<Output = Result<Data>> + Send + 'static, OnPing: FnOnce(Option<&Data>, Option<Value>) -> OnPingFut + Clone + Send + 'static, OnPingFut: Future<Output = Result<Option<Value>>> + Send + 'static,

fn into_response(self) -> Response

Converts the implementing type into an HTTP response.