Struct jsonrpsee_core::server::rpc_module::Subscription

pub struct Subscription { /* private fields */ }

Wrapper struct that maintains a subscription “mainly” for testing.

Implementations

impl Subscription

pub fn close(&mut self)

Close the subscription channel.

pub fn subscription_id(&self) -> &RpcSubscriptionId<'_>

Get the subscription ID

pub fn is_closed(&self) -> bool

Check whether the subscription is closed.

pub async fn next<T: DeserializeOwned>(
    &mut self
) -> Option<Result<(T, RpcSubscriptionId<'static>), Error>>

Returns Some((val, sub_id)) for the next element of type T from the underlying stream, otherwise None if the subscription was closed.

Panics

If the decoding the value as T fails.

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.

impl Drop for Subscription

fn drop(&mut self)

Executes the destructor for this type.