- Rust 100%
1bad5a173b
Co-authored-by: GraphQl Release Bot <graphql-ws-releases@grambo.me.uk> Co-authored-by: Graeme Coupar <graeme@turbofish.tech> Reviewed-on: #156 Co-authored-by: Forgejo Actions <forgejo-actions@noreply.codeberg.org> Co-committed-by: Forgejo Actions <forgejo-actions@noreply.codeberg.org> |
||
|---|---|---|
| .forgejo/workflows | ||
| examples | ||
| examples-wasm | ||
| schemas | ||
| src | ||
| tests | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| release-plz.toml | ||
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
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.
Getting Help
If you want help with graphql-ws-client you can join the #cynic chat room on IRC using any of these options:
- A Web UI
- Using this link if you have an IRC client
- Selecting a client from joinrc.at
- Joining #cynic on irc.libera.chat if you know what you're doing