graphql-ws-client
| Crates.io | graphql-ws-client |
| lib.rs | graphql-ws-client |
| version | 0.12.0 |
| created_at | 2021-04-04 17:36:33.43081+00 |
| updated_at | 2026-01-11 21:58:03.062213+00 |
| description | A graphql over websockets client |
| homepage | |
| repository | https://github.com/obmarg/graphql-ws-client |
| max_upload_size | |
| id | 378887 |
| size | 179,665 |
Graeme Coupar (obmarg)
documentation
README
Overview
The goal of this library is to provide a runtime agnostic implementation for GraphQL-over-Websockets.
The library only supports subscriptions for now but will eventually support queries and mutations.
It supports the websocket libraries async-tungstenite, tokio-tungstenite and ws-stream-wasm, and
Tungstenite Versions
As the tungstenite library is pre-1.0 graphql-ws-client provides support for
a range of versions. You can select which version of tungestenite you want
using the tungstenite-0-xx feature flags. Note that only one of these can be
active at any time, or graphql-ws-client won't compile. Because of these
limitations only one tungstenite version will be tested on the
grapqhl-ws-client CI, as a result the other versions may not compile or
work corectly.
Integrations
The library offers integrations with some popular GraphQL clients with feature flags:
- graphql-client:
features = ["client-graphql-client"] - cynic:
features = ["client-cynic"]
Documentation
The documentation is quite limited at the moment, here are some sources:
Logging
By default, the library will log some messages at the trace level to help you debug.
It is possible to turn off the logging entirely by using the no-logging feature.