Struct Ws

pub struct Ws { /* private fields */ }

Available on crate feature legacy-ws only.

A JSON-RPC Client over Websockets.

Example

use ethers_providers::Ws;

let ws = Ws::connect("ws://localhost:8545").await?;

Implementations

impl Ws

pub fn new<S>(ws: S) -> Self

where S: Send + Sync + Stream<Item = Result<Message, Error>> + Sink<Message, Error = Error> + Unpin + 'static,

Initializes a new WebSocket Client, given a Stream/Sink Websocket implementer. The websocket connection must be initiated separately.

pub fn ready(&self) -> bool

Returns true if the WS connection is active, false otherwise

pub async fn connect( url: impl IntoClientRequest + Unpin, ) -> Result<Self, ClientError>

Available on non-WebAssembly only.

Initializes a new WebSocket Client

pub async fn connect_with_auth( uri: impl IntoClientRequest + Unpin, auth: Authorization, ) -> Result<Self, ClientError>

Available on non-WebAssembly only.

Initializes a new WebSocket Client with authentication

Trait Implementations

impl Clone for Ws

fn clone(&self) -> Ws

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ws

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

Formats the value using the given formatter.

impl JsonRpcClient for Ws

type Error = ClientError

A JSON-RPC Error

fn request<'life0, 'life1, 'async_trait, T, R>( &'life0 self, method: &'life1 str, params: T, ) -> Pin<Box<dyn Future<Output = Result<R, ClientError>> + Send + 'async_trait>>

where T: 'async_trait + Serialize + Send + Sync, R: 'async_trait + DeserializeOwned, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a request with the provided JSON-RPC and parameters serialized as JSON

impl PubsubClient for Ws

type NotificationStream = UnboundedReceiver<Box<RawValue>>

The type of stream this transport returns

fn subscribe<T: Into<U256>>( &self, id: T, ) -> Result<Self::NotificationStream, ClientError>

Add a subscription to this transport

fn unsubscribe<T: Into<U256>>(&self, id: T) -> Result<(), ClientError>

Remove a subscription from this transport