Struct async_graphql_actix_web::GraphQLSubscription

source · [−]

pub struct GraphQLSubscription<Query, Mutation, Subscription, OnInit> { /* private fields */ }

Expand description

A builder for websocket subscription actor.

Implementations

source

impl<Query, Mutation, Subscription> GraphQLSubscription<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
 Query: ObjectType + 'static,
 Mutation: ObjectType + 'static,
 Subscription: SubscriptionType + 'static,

source

pub fn new(schema: Schema<Query, Mutation, Subscription>) -> Self

Create a GraphQL subscription builder.

source

impl<Query, Mutation, Subscription, OnInit, OnInitFut> GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
 Query: ObjectType + 'static,
 Mutation: ObjectType + 'static,
 Subscription: SubscriptionType + 'static,
 OnInit: Fn(Value) -> OnInitFut + Unpin + Send + 'static,
 OnInitFut: Future<Output = Result<Data>> + Send + 'static,

source

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.

source

pub fn on_connection_init<OnConnInit2, Fut>(
 self,
 callback: OnConnInit2
) -> GraphQLSubscription<Query, Mutation, Subscription, OnConnInit2> where
 OnConnInit2: Fn(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].

source

pub fn start<S>(
 self,
 request: &HttpRequest,
 stream: S
) -> Result<HttpResponse, Error> where
 S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

Start the subscription actor.

Auto Trait Implementations

impl<Query, Mutation, Subscription, OnInit> !RefUnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

impl<Query, Mutation, Subscription, OnInit> Send for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
 Mutation: Send + Sync,
 OnInit: Send,
 Query: Send + Sync,
 Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Sync for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
 Mutation: Send + Sync,
 OnInit: Sync,
 Query: Send + Sync,
 Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Unpin for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
OnInit: Unpin,

impl<Query, Mutation, Subscription, OnInit> !UnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct async_graphql_actix_web::GraphQLSubscription

Implementations

impl<Query, Mutation, Subscription> GraphQLSubscription<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
    Query: ObjectType + 'static,
    Mutation: ObjectType + 'static,
    Subscription: SubscriptionType + 'static,

pub fn new(schema: Schema<Query, Mutation, Subscription>) -> Self

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

pub fn on_connection_init<OnConnInit2, Fut>(
    self,
    callback: OnConnInit2
) -> GraphQLSubscription<Query, Mutation, Subscription, OnConnInit2> where
    OnConnInit2: Fn(Value) -> Fut + Unpin + Send + 'static,
    Fut: Future<Output = Result<Data>> + Send + 'static,

pub fn start<S>(
    self,
    request: &HttpRequest,
    stream: S
) -> Result<HttpResponse, Error> where
    S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

Auto Trait Implementations

impl<Query, Mutation, Subscription, OnInit> !RefUnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

impl<Query, Mutation, Subscription, OnInit> Send for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
    Mutation: Send + Sync,
    OnInit: Send,
    Query: Send + Sync,
    Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Sync for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
    Mutation: Send + Sync,
    OnInit: Sync,
    Query: Send + Sync,
    Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Unpin for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
OnInit: Unpin,

impl<Query, Mutation, Subscription, OnInit> !UnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct async_graphql_actix_web::GraphQLSubscription

Implementations

impl<Query, Mutation, Subscription> GraphQLSubscription<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where Query: ObjectType + 'static, Mutation: ObjectType + 'static, Subscription: SubscriptionType + 'static,

pub fn new(schema: Schema<Query, Mutation, Subscription>) -> Self

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

pub fn on_connection_init<OnConnInit2, Fut>( self, callback: OnConnInit2) -> GraphQLSubscription<Query, Mutation, Subscription, OnConnInit2> where OnConnInit2: Fn(Value) -> Fut + Unpin + Send + 'static, Fut: Future<Output = Result<Data>> + Send + 'static,

pub fn start<S>( self, request: &HttpRequest, stream: S) -> Result<HttpResponse, Error> where S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

Auto Trait Implementations

impl<Query, Mutation, Subscription, OnInit> !RefUnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

impl<Query, Mutation, Subscription, OnInit> Send for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where Mutation: Send + Sync, OnInit: Send, Query: Send + Sync, Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Sync for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where Mutation: Send + Sync, OnInit: Sync, Query: Send + Sync, Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Unpin for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where OnInit: Unpin,

impl<Query, Mutation, Subscription, OnInit> !UnwindSafe for GraphQLSubscription<Query, Mutation, Subscription, OnInit>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<Query, Mutation, Subscription> GraphQLSubscription<Query, Mutation, Subscription, fn(_: Value) -> Ready<Result<Data>>> where
Query: ObjectType + 'static,
Mutation: ObjectType + 'static,
Subscription: SubscriptionType + 'static,

pub fn on_connection_init<OnConnInit2, Fut>(
self,
callback: OnConnInit2
) -> GraphQLSubscription<Query, Mutation, Subscription, OnConnInit2> where
OnConnInit2: Fn(Value) -> Fut + Unpin + Send + 'static,
Fut: Future<Output = Result<Data>> + Send + 'static,

pub fn start<S>(
self,
request: &HttpRequest,
stream: S
) -> Result<HttpResponse, Error> where
S: Stream<Item = Result<Bytes, PayloadError>> + 'static,

impl<Query, Mutation, Subscription, OnInit> Send for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
Mutation: Send + Sync,
OnInit: Send,
Query: Send + Sync,
Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Sync for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
Mutation: Send + Sync,
OnInit: Sync,
Query: Send + Sync,
Subscription: Send + Sync,

impl<Query, Mutation, Subscription, OnInit> Unpin for GraphQLSubscription<Query, Mutation, Subscription, OnInit> where
OnInit: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,