Struct Subscription 

pub struct Subscription { /* private fields */ }

An interface that can be used to asynchronously receive Events for a particular subscription.

Examples

use tendermint_rpc::Subscription;
use futures::StreamExt;

/// Prints `count` events from the given subscription.
async fn print_events(subs: &mut Subscription, count: usize) {
    let mut counter = 0_usize;
    while let Some(res) = subs.next().await {
        // Technically, a subscription produces `Result<Event, Error>`
        // instances. Errors can be produced by the remote endpoint at any
        // time and need to be handled here.
        let ev = res.unwrap();
        println!("Got incoming event: {:?}", ev);
        counter += 1;
        if counter >= count {
            break
        }
    }
}

Implementations

impl Subscription

pub fn new( id: String, query: Query, rx: ChannelRx<Result<Event, Error>>, ) -> Subscription

pub fn id(&self) -> &str

Return this subscription’s ID for informational purposes.

pub fn query(&self) -> &Query

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.

impl Stream for Subscription

type Item = Result<Event, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Subscription>, cx: &mut Context<'_>, ) -> Poll<Option<<Subscription as Stream>::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> Unpin for Subscription

where <PinnedFieldsOfHelperStruct<__Subscription<'pin>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,