Struct Client

pub struct Client { /* private fields */ }

A GraphQL over Websocket client

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

let (mut client, actor) = Client::build(connection).await?;

// Spawn the actor onto an async runtime
spawn(actor.into_future());

let mut subscription = client.subscribe(subscription).await?;

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

Implementations

impl Client

pub fn build<Conn>(connection: Conn) -> ClientBuilder

where Conn: Connection + Send + 'static,

Creates a ClientBuilder with the given connection.

use graphql_ws_client::Client;
use std::future::IntoFuture;
let (client, actor) = Client::build(connection).await?;

impl Client

pub async fn subscribe<'a, Operation>( &self, op: Operation, ) -> Result<Subscription<Operation>, Error>

where Operation: GraphqlOperation + Unpin + Send + 'static,

Starts a streaming operation on this client.

Returns a Stream of responses.

pub async fn close(self, code: u16, description: impl Into<String>)

Gracefully closes the connection

This will stop all running subscriptions and shut down the ConnectionActor wherever it is running.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.