Struct async_graphql_tide::GraphQLSubscription

pub struct GraphQLSubscription<E, OnConnInit> { /* private fields */ }

A GraphQL subscription endpoint builder.

Implementations

impl<E> GraphQLSubscription<E, fn(_: Value) -> Ready<Result<Data>>>where
    E: Executor,

pub fn new(executor: E) -> Self

Create a GraphQLSubscription object.

impl<E, OnConnInit, OnConnInitFut> GraphQLSubscription<E, OnConnInit>where
    E: Executor,
    OnConnInit: Fn(Value) -> OnConnInitFut + Clone + Send + Sync + 'static,
    OnConnInitFut: Future<Output = Result<Data>> + Send + 'static,

pub fn on_connection_init<OnConnInit2, Fut>(
    self,
    callback: OnConnInit2
) -> GraphQLSubscription<E, OnConnInit2>where
    OnConnInit2: Fn(Value) -> Fut + Clone + Send + Sync + 'static,
    Fut: Future<Output = Result<Data>> + Send + 'static,

Specify a callback function to be called when the connection is initialized.

You can get something from the payload of GQL_CONNECTION_INIT message to create Data. The data returned by this callback function will be merged with the data specified by [with_data].

pub fn build<S: Send + Sync + Clone + 'static>(self) -> impl Endpoint<S>

Consumes this builder to create a tide endpoint.