Struct WebsocketClient

pub struct WebsocketClient { /* private fields */ }

A websocket JSON-RPC client.

Implementations

impl WebsocketClient

pub async fn new( url: Url, basic_auth: Option<Credentials>, ) -> Result<Self, Error>

Creates a new JSON-RPC websocket client.

Arguments

• url: The URL of the websocket endpoint (.e.g ws://localhost:8000/ws)
• basic_auth: Credentials for HTTP basic auth.

pub async fn with_url(url: Url) -> Result<Self, Error>

Creates a new JSON-RPC websocket client.

Arguments

• url: The URL of the websocket endpoint (.e.g ws://localhost:8000/ws)

Trait Implementations

impl Client for WebsocketClient

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close the websocket connection

type Error = Error

Error type that this client returns.

fn send_request<'life0, 'life1, 'life2, 'async_trait, P, R>( &'life0 self, method: &'life1 str, params: &'life2 P, ) -> Pin<Box<dyn Future<Output = Result<R, Self::Error>> + Send + 'async_trait>>

where P: Serialize + Debug + Send + Sync + 'async_trait, R: for<'de> Deserialize<'de> + Debug + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Sends a JSON-HTTP request

fn connect_stream<'life0, 'async_trait, T>( &'life0 self, id: SubscriptionId, ) -> Pin<Box<dyn Future<Output = BoxStream<'static, T>> + Send + 'async_trait>>

where T: for<'de> Deserialize<'de> + Debug + Send + Sync + 'async_trait + Unpin + 'static, Self: 'async_trait, 'life0: 'async_trait,

If the client supports streams (i.e. receiving notifications), this should return a stream for the specific subscription ID.

fn disconnect_stream<'life0, 'async_trait>( &'life0 self, id: SubscriptionId, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

If the client supports streams (i.e. receiving notifications) and there is a matching subscription ID, this should close the corresponding stream.