Struct ethers_providers::SubscriptionStream

pub struct SubscriptionStream<'a, P: PubsubClient, R: DeserializeOwned> {
    pub id: U256,
    /* private fields */
}

Streams data from an installed filter via eth_subscribe

Fields

id: U256

The subscription’s installed id on the ethereum node

Implementations

impl<'a, P, R> SubscriptionStream<'a, P, R>

where P: PubsubClient, R: DeserializeOwned,

pub fn new(id: U256, provider: &'a Provider<P>) -> Result<Self, P::Error>

Creates a new subscription stream for the provided subscription id.

Note

Most providers treat SubscriptionStream IDs as global singletons. Instantiating this directly with a known ID will likely cause any existing streams with that ID to end. To avoid this, start a new stream using Provider::subscribe instead of SubscriptionStream::new.

pub async fn unsubscribe(&self) -> Result<bool, ProviderError>

Unsubscribes from the subscription.

pub fn set_loaded_elements(&mut self, loaded_elements: VecDeque<R>)

Set the loaded elements buffer. This buffer contains logs waiting for the consumer to read. Setting the buffer can be used to add logs without receiving them from the RPC node

Warning

Setting the buffer will drop any logs in the current buffer.

impl<'a, P> SubscriptionStream<'a, P, TxHash>

where P: PubsubClient,

pub fn transactions_unordered(self, n: usize) -> TransactionStream<'a, P, Self>

Returns a stream that yields the Transactions for the transaction hashes this stream yields.

This internally calls Provider::get_transaction with every new transaction. No more than n futures will be buffered at any point in time, and less than n may also be buffered depending on the state of each future.

Trait Implementations

impl<'a, P: PubsubClient, R: DeserializeOwned> Drop for SubscriptionStream<'a, P, R>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, P, R> Stream for SubscriptionStream<'a, P, R>

where P: PubsubClient, R: DeserializeOwned,

type Item = R

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, ctx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, 'a, P: PubsubClient, R: DeserializeOwned> Unpin for SubscriptionStream<'a, P, R>

where __SubscriptionStream<'pin, 'a, P, R>: Unpin,