Struct Subscription 

pub struct Subscription { /* private fields */ }

A cursor-based CDC subscription.

Holds a read position into a CdcRing and an optional glob pattern used to filter events by key. Call poll to consume the next batch of matching events.

Implementations

impl Subscription

pub fn new(id: u64, pattern: Option<String>) -> Self

Create a subscription starting from sequence 0.

pub fn with_cursor(id: u64, pattern: Option<String>, cursor: u64) -> Self

Create a subscription starting from the given sequence number.

pub fn id(&self) -> u64

Return the unique subscription ID.

pub fn cursor(&self) -> u64

Return the current read-cursor position (next sequence to consume).

pub fn pattern(&self) -> Option<&str>

Return the glob pattern, if one was set.

pub fn poll(&mut self, ring: &CdcRing, limit: usize) -> CdcReadResult

Read up to limit new events from ring, advancing the cursor.

When a pattern is set, only events whose key matches the glob are included in the returned batch. The cursor still advances past non-matching events so they are not re-examined on the next poll.

pub fn seek(&mut self, seq: u64)

Reposition the read cursor to an arbitrary sequence number.