Struct ethers_providers::Ws

source ·
pub struct Ws { /* private fields */ }
Available on crate feature legacy-ws only.
Expand description

A JSON-RPC Client over Websockets.

§Example

use ethers_providers::Ws;

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

Implementations§

source§

impl Ws

source

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.

source

pub fn ready(&self) -> bool

Returns true if the WS connection is active, false otherwise

source

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

Available on non-WebAssembly only.

Initializes a new WebSocket Client

source

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§

source§

impl Clone for Ws

source§

fn clone(&self) -> Ws

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Ws

source§

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

Formats the value using the given formatter. Read more
source§

impl JsonRpcClient for Ws

§

type Error = ClientError

A JSON-RPC Error
source§

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
source§

impl PubsubClient for Ws

§

type NotificationStream = UnboundedReceiver<Box<RawValue>>

The type of stream this transport returns
source§

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

Add a subscription to this transport
source§

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

Remove a subscription from this transport

Auto Trait Implementations§

§

impl !RefUnwindSafe for Ws

§

impl Send for Ws

§

impl Sync for Ws

§

impl Unpin for Ws

§

impl !UnwindSafe for Ws

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<C> JsonRpcClientWrapper for C
where C: JsonRpcClient,

source§

fn request<'life0, 'life1, 'async_trait>( &'life0 self, method: &'life1 str, params: QuorumParams ) -> Pin<Box<dyn Future<Output = Result<Value, ProviderError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, C: 'async_trait,

Make a request, as crate::JsonRpcClient
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> JsonSchemaMaybe for T