Struct CheckpointDriver 

pub struct CheckpointDriver { /* private fields */ }

Drives cursor checkpoints according to the channel’s configured policy.

Implementations

impl CheckpointDriver

pub fn new(policy: impl Into<CheckpointPolicy>) -> Self

Creates a checkpoint driver from a checkpoint policy or full durability config.

pub const fn from_policy(policy: CheckpointPolicy) -> Self

Creates a checkpoint driver from an explicit checkpoint policy.

pub const fn from_config(config: DurabilityConfig) -> Self

Creates a checkpoint driver from a durability configuration.

pub const fn policy(&self) -> CheckpointPolicy

Returns the active checkpoint policy.

pub const fn messages_since_last_checkpoint(&self) -> usize

Returns the number of processed messages since the last successful checkpoint.

pub const fn pending_offset(&self) -> Option<u64>

Returns the latest processed offset waiting to be checkpointed.

pub async fn record_processed( &mut self, cursor: &mut ConsumerCursor, store: &dyn DurableStore, next_offset: u64, ) -> Result<(), DurabilityError>

Records one processed message and checkpoints if the configured policy requires it.

next_offset is the partition offset from which the consumer should resume after the processed message. The driver delegates all persistence to ConsumerCursor::checkpoint.

Errors

Returns cursor checkpoint errors from the store, or a configuration error for an invalid raw batch policy.

pub async fn flush( &mut self, cursor: &mut ConsumerCursor, store: &dyn DurableStore, ) -> Result<(), DurabilityError>

Flushes any processed offset that is waiting to be checkpointed.

Errors

Returns cursor checkpoint errors from the store, or a configuration error for an invalid raw batch policy.

Trait Implementations

impl Clone for CheckpointDriver

fn clone(&self) -> CheckpointDriver

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CheckpointDriver

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

Formats the value using the given formatter.

impl Eq for CheckpointDriver

impl PartialEq for CheckpointDriver

fn eq(&self, other: &CheckpointDriver) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CheckpointDriver