Struct jsonrpc_pubsub::Subscriber

pub struct Subscriber { /* fields omitted */ }

Represents a subscribing client. Subscription handlers can either reject this subscription request or assign an unique id.

Implementations

impl Subscriber

pub fn new_test<T: Into<String>>(
    method: T
) -> (Self, Receiver<Result<SubscriptionId, Error>>, UnboundedReceiver<String>)

Creates new subscriber.

Should only be used for tests.

pub fn assign_id(self, id: SubscriptionId) -> Result<Sink, ()>

Consumes Subscriber and assigns unique id to a requestor.

Returns Err if request has already terminated.

pub fn assign_id_async(
    self,
    id: SubscriptionId
) -> impl Future<Output = Result<Sink, ()>>

Consumes Subscriber and assigns unique id to a requestor.

The returned Future resolves when the subscriber receives subscription id. Resolves to Err if request has already terminated.

pub fn reject(self, error: Error) -> Result<(), ()>

Rejects this subscription request with given error.

Returns Err if request has already terminated.

pub fn reject_async(self, error: Error) -> impl Future<Output = Result<(), ()>>

Rejects this subscription request with given error.

The returned Future resolves when the rejection is sent to the client. Resolves to Err if request has already terminated.

Trait Implementations

impl Debug for Subscriber

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

Formats the value using the given formatter.