Crate graphql_ws_client

graphql-ws-client

graphql-ws-client implements asynchronous GraphQL-over-Websocket using the graphql-transport-ws protocol. It is websocket client, graphql client and async runtime agnostic. Built in support is provided for:

• Cynic & Graphql-Client GraphQL clients.
• async-tungstenite & ws-stream-wasm Websocket Clients .
• Any async runtime.

If you’d like to use another client or adding support should be trivial.

use graphql_ws_client::Client;
use std::future::IntoFuture;
use futures::StreamExt;

let mut stream = Client::build(connection).subscribe(subscription).await?;

while let Some(response) = stream.next().await {
    // Do something with response
}

See the examples for more thorough usage details.

Modules

• graphql
  This module contains traits that abstract over GraphQL implementations, allowing this library to be used with different GraphQL client libraries.
• websockets
  Contains traits to provide support for various underlying websocket clients.
• ws_stream_wasmws_stream_wasm
  Integration with the ws_stream_wasm library

Structs

• AsyncWebsocketClientDeprecated
  A websocket client
• AsyncWebsocketClientBuilderDeprecated
  A websocket client builder
• Client
  A GraphQL over Websocket client
• ClientBuilder
  Builder for Graphql over Websocket clients
• ConnectionActor
  The ConnectionActor contains the main loop for handling incoming & outgoing messages for a Client.
• FusedWasmWebsocketSinkDeprecatedws_stream_wasm
  Sink for the with method.
• Subscription
  A futures::Stream for a subscription.
• SubscriptionStream
  A futures::Stream for a subscription.

Enums

• Error
  Error type
• Message
  A websocket message
• WasmWebsocketMessagews_stream_wasm
  A WebSocket event abstraction to combine the differentiated WebSocket events and messages of ws_stream_wasm.

Traits

• Connection
  Abstrction around a websocket connection.

Functions

• wasm_websocket_combined_splitDeprecatedws_stream_wasm
  Creates a new pair of sink and stream which operate on WasmWebsocketMessage instead of WsMessage and WsEvent separately.

Type Aliases

• CynicClientDeprecatedcynic
  A websocket client for the cynic graphql crate
• CynicClientBuilderDeprecatedcynic
  A websocket client builder for the cynic graphql crate
• GraphQLClientClientDeprecatedclient-graphql-client
  A websocket client for the graphql_client graphql crate
• GraphQLClientClientBuilderDeprecatedclient-graphql-client
  A websocket client builder for the graphql_client graphql crate