Struct async_graphql_warp::GraphQLWebSocket
source · pub struct GraphQLWebSocket<Sink, Stream, E, OnInit> { /* private fields */ }
Expand description
A Websocket connection for GraphQL subscription.
Examples
use std::time::Duration;
use async_graphql::*;
use async_graphql_warp::*;
use futures_util::stream::{Stream, StreamExt};
use warp::{ws, Filter};
struct QueryRoot;
#[Object]
impl QueryRoot {
async fn value(&self) -> i32 {
// A GraphQL Object type must define one or more fields.
100
}
}
struct SubscriptionRoot;
#[Subscription]
impl SubscriptionRoot {
async fn tick(&self) -> impl Stream<Item = String> {
async_stream::stream! {
let mut interval = tokio::time::interval(Duration::from_secs(1));
loop {
let n = interval.tick().await;
yield format!("{}", n.elapsed().as_secs_f32());
}
}
}
}
let schema = Schema::new(QueryRoot, EmptyMutation, SubscriptionRoot);
let filter = warp::ws()
.and(graphql_protocol())
.map(move |ws: ws::Ws, protocol| {
let schema = schema.clone();
let reply = ws
.on_upgrade(move |socket| GraphQLWebSocket::new(socket, schema, protocol).serve());
warp::reply::with_header(
reply,
"Sec-WebSocket-Protocol",
protocol.sec_websocket_protocol(),
)
});
warp::serve(filter).run(([0, 0, 0, 0], 8000)).await;
Implementations
sourceimpl<S, E> GraphQLWebSocket<SplitSink<S, Message>, SplitStream<S>, E, fn(_: Value) -> Ready<Result<Data>>>where
S: Stream<Item = Result<Message, Error>> + Sink<Message>,
E: Executor,
impl<S, E> GraphQLWebSocket<SplitSink<S, Message>, SplitStream<S>, E, fn(_: Value) -> Ready<Result<Data>>>where
S: Stream<Item = Result<Message, Error>> + Sink<Message>,
E: Executor,
sourcepub fn new(socket: S, executor: E, protocol: WebSocketProtocols) -> Self
pub fn new(socket: S, executor: E, protocol: WebSocketProtocols) -> Self
Create a GraphQLWebSocket
object.
sourceimpl<Sink, Stream, E> GraphQLWebSocket<Sink, Stream, E, fn(_: Value) -> Ready<Result<Data>>>where
Sink: Sink<Message>,
Stream: Stream<Item = Result<Message, Error>>,
E: Executor,
impl<Sink, Stream, E> GraphQLWebSocket<Sink, Stream, E, fn(_: Value) -> Ready<Result<Data>>>where
Sink: Sink<Message>,
Stream: Stream<Item = Result<Message, Error>>,
E: Executor,
sourcepub fn new_with_pair(
sink: Sink,
stream: Stream,
executor: E,
protocol: WebSocketProtocols
) -> Self
pub fn new_with_pair(
sink: Sink,
stream: Stream,
executor: E,
protocol: WebSocketProtocols
) -> Self
Create a GraphQLWebSocket
object with sink and stream objects.
sourceimpl<Sink, Stream, E, OnConnInit, OnConnInitFut> GraphQLWebSocket<Sink, Stream, E, OnConnInit>where
Sink: Sink<Message>,
Stream: Stream<Item = Result<Message, Error>>,
E: Executor,
OnConnInit: FnOnce(Value) -> OnConnInitFut + Send + 'static,
OnConnInitFut: Future<Output = Result<Data>> + Send + 'static,
impl<Sink, Stream, E, OnConnInit, OnConnInitFut> GraphQLWebSocket<Sink, Stream, E, OnConnInit>where
Sink: Sink<Message>,
Stream: Stream<Item = Result<Message, Error>>,
E: Executor,
OnConnInit: FnOnce(Value) -> OnConnInitFut + Send + 'static,
OnConnInitFut: Future<Output = Result<Data>> + Send + 'static,
sourcepub fn with_data(self, data: Data) -> Self
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.
sourcepub fn on_connection_init<OnConnInit2, Fut>(
self,
callback: OnConnInit2
) -> GraphQLWebSocket<Sink, Stream, E, OnConnInit2>where
OnConnInit2: FnOnce(Value) -> Fut + Send + 'static,
Fut: Future<Output = Result<Data>> + Send + 'static,
pub fn on_connection_init<OnConnInit2, Fut>(
self,
callback: OnConnInit2
) -> GraphQLWebSocket<Sink, Stream, E, OnConnInit2>where
OnConnInit2: FnOnce(Value) -> Fut + 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
].
Auto Trait Implementations
impl<Sink, Stream, E, OnInit> !RefUnwindSafe for GraphQLWebSocket<Sink, Stream, E, OnInit>
impl<Sink, Stream, E, OnInit> Send for GraphQLWebSocket<Sink, Stream, E, OnInit>where
E: Send,
OnInit: Send,
Sink: Send,
Stream: Send,
impl<Sink, Stream, E, OnInit> Sync for GraphQLWebSocket<Sink, Stream, E, OnInit>where
E: Sync,
OnInit: Sync,
Sink: Sync,
Stream: Sync,
impl<Sink, Stream, E, OnInit> Unpin for GraphQLWebSocket<Sink, Stream, E, OnInit>where
E: Unpin,
OnInit: Unpin,
Sink: Unpin,
Stream: Unpin,
impl<Sink, Stream, E, OnInit> !UnwindSafe for GraphQLWebSocket<Sink, Stream, E, OnInit>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more