Struct jsonrpsee_core::client::Subscription

pub struct Subscription<Notif> { /* private fields */ }

Available on crate feature client only.

Active subscription on the client.

It will automatically unsubscribe in the Subscription::drop so no need to explicitly call the unsubscribe method if it is an an subscription based on SubscriptionId.

Implementations

impl<Notif> Subscription<Notif>

pub fn new( to_back: Sender<FrontToBack>, notifs_rx: Receiver<JsonValue>, kind: SubscriptionKind ) -> Self

Create a new subscription.

pub fn kind(&self) -> &SubscriptionKind

Return the subscription type and, if applicable, ID.

pub async fn unsubscribe(self) -> Result<(), Error>

Unsubscribe and consume the subscription.

impl<Notif> Subscription<Notif>where Notif: DeserializeOwned,

pub async fn next(&mut self) -> Option<Result<Notif, Error>>

Returns the next notification from the stream. This may return None if the subscription has been terminated, which may happen if the channel becomes full or is dropped.

Note: This has an identical signature to the StreamExt::next method (and delegates to that). Import StreamExt if you’d like access to other stream combinator methods.

Trait Implementations

impl<Notif: Debug> Debug for Subscription<Notif>

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

Formats the value using the given formatter.

impl<Notif> Drop for Subscription<Notif>

fn drop(&mut self)

Executes the destructor for this type.

impl<Notif> Stream for Subscription<Notif>where Notif: DeserializeOwned,

type Item = Result<Notif, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &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<Notif> Unpin for Subscription<Notif>