Struct async_nats::Subscription

pub struct Subscription { /* fields omitted */ }

A subscription to a subject.

Due to async limitations (lack of AsyncDrop etc…), please call Subscription::unsubscribe().await manually before dropping Subscription to avoid blocking the runtime.

Implementations

impl Subscription

pub async fn next(&self) -> Option<Message>

Gets the next message, or returns None if the subscription has been unsubscribed or the connection is closed.

pub async fn drain(&self) -> Result<()>

Stops listening for new messages, but the remaining queued messages can still be received.

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

Stops listening for new messages and discards the remaining queued messages. This should always be called before dropping async_nats::Subscription to avoid blocking the non-async Drop implementation.

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.