Struct async_graphql_actix_web::GraphQLSubscription

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

A builder for websocket subscription actor.

Implementations

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

pub fn new(executor: E) -> Self

Create a GraphQL subscription builder.

impl<E, OnInit, OnInitFut> GraphQLSubscription<E, OnInit>where E: Executor, OnInit: FnOnce(Value) -> OnInitFut + Unpin + Send + 'static, OnInitFut: Future<Output = Result<Data>> + Send + 'static,

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

Specify the initial subscription context data, usually you can get something from the incoming request to create it.

pub fn on_connection_init<OnConnInit2, Fut>( self, callback: OnConnInit2 ) -> GraphQLSubscription<E, OnConnInit2>where OnConnInit2: FnOnce(Value) -> Fut + Unpin + Send + '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 start<S>( self, request: &HttpRequest, stream: S ) -> Result<HttpResponse, Error>where S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

Start the subscription actor.