Struct EventSubscription 

pub struct EventSubscription { /* private fields */ }

A handle to an individual SierraDB subscription.

Provides a typed interface for receiving subscription messages.

Implementations

impl EventSubscription

pub fn subscription_id(&self) -> Uuid

Get the unique identifier for this subscription.

pub async fn next_message(&mut self) -> Option<SierraMessage>

Receive the next message from this subscription.

Returns None if the subscription has been closed.

pub fn into_stream(self) -> impl Stream<Item = SierraMessage>

Convert this subscription into a stream of messages.

This consumes the subscription and returns a stream that can be used with stream combinators like while let Some(msg) = stream.next().await.

pub async fn acknowledge_up_to_cursor(&self, cursor: u64) -> RedisResult<()>

Acknowledge events up to a specific cursor for this subscription.

The cursor value is provided with each event in the subscription stream. Acknowledging up to a cursor allows the subscription window to advance.

pub async fn unsubscribe(self) -> RedisResult<()>

Unsubscribe and close this subscription.

After calling this, no more messages will be received.

Trait Implementations

impl Drop for EventSubscription

fn drop(&mut self)

Executes the destructor for this type.