Struct ethers_providers::Ws

source · [−]

pub struct Ws { /* private fields */ }

Expand description

A JSON-RPC Client over Websockets.

use ethers_providers::Ws;

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

Implementations

source

impl Ws

source

pub fn new<S: 'static>(ws: S) -> Self where
S: Send + Sync + Stream<Item = Result<Message, Error>> + Sink<Message, Error = Error> + Unpin,

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>

Initializes a new WebSocket Client

source

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

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,
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: '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, Global>>

The type of stream this transport returns

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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<T> Same<T> 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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

Struct ethers_providers::Ws

Implementations

impl Ws

pub fn new<S: 'static>(ws: S) -> Self where S: Send + Sync + Stream<Item = Result<Message, Error>> + Sink<Message, Error = Error> + Unpin,

pub fn ready(&self) -> bool

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

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

Trait Implementations

impl Clone for Ws

fn clone(&self) -> Ws

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

impl Debug for Ws

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

impl JsonRpcClient for Ws

type Error = ClientError

impl PubsubClient for Ws

type NotificationStream = UnboundedReceiver<Box<RawValue, Global>>

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

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

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

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new<S: 'static>(ws: S) -> Self where
S: Send + Sync + Stream<Item = Result<Message, Error>> + Sink<Message, Error = Error> + Unpin,

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

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

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

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

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

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

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

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

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

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

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

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