Enum OffsetStore 

pub enum OffsetStore {
    Remote(RemoteBrokerOffsetStore),
    Local(LocalFileOffsetStore),
}

The active offset storage backend for a message consumer.

Exactly one variant is active during the lifetime of a consumer:

• Remote is used in clustering mode, where offsets are coordinated through the broker.
• Local is used in broadcasting mode, where offsets are stored in a local file on the consumer host.

Variants

Remote(RemoteBrokerOffsetStore)

Offsets persisted to and retrieved from the remote broker.

Local(LocalFileOffsetStore)

Offsets persisted to and retrieved from a local file.

Implementations

impl OffsetStore

pub fn new_with_remote( remote_broker_offset_store: RemoteBrokerOffsetStore, ) -> Self

Returns an OffsetStore backed by remote broker offset storage.

pub fn new_with_local(local_file_offset_store: LocalFileOffsetStore) -> Self

Returns an OffsetStore backed by local file offset storage.

pub async fn load(&self) -> ClientResult<()>

Asynchronously loads persisted offsets from the underlying storage backend.

Errors

Returns an error if the underlying storage backend fails to read or deserialize the persisted offset data.

pub async fn update_offset( &self, mq: &MessageQueue, offset: i64, increase_only: bool, )

Asynchronously updates the stored offset for the given queue.

When increase_only is true, the offset is updated only if the new value is greater than the currently stored value.

pub async fn update_and_freeze_offset(&self, mq: &MessageQueue, offset: i64)

Asynchronously updates the stored offset for the given queue and prevents further updates until the freeze is lifted.

pub async fn read_offset(&self, mq: &MessageQueue, type_: ReadOffsetType) -> i64

Asynchronously reads the current offset for the given queue according to the specified read strategy.

Returns 0 if no offset has been recorded for the queue.

pub async fn persist_all(&self, mqs: &HashSet<MessageQueue>)

Asynchronously persists the offsets for all queues in mqs to the underlying storage backend.

pub async fn persist(&self, mq: &MessageQueue)

Asynchronously persists the offset for the specified queue to the underlying storage backend.

pub async fn remove_offset(&self, mq: &MessageQueue)

Asynchronously removes the stored offset entry for the specified queue.

pub async fn clone_offset_table( &self, topic: &str, ) -> HashMap<MessageQueue, i64>

Asynchronously returns a snapshot of the offset table filtered by the given topic.

pub async fn update_consume_offset_to_broker( &self, mq: &MessageQueue, offset: i64, is_oneway: bool, ) -> ClientResult<()>

Asynchronously pushes the given offset for the specified queue to the broker.

When is_oneway is true, the request is sent without waiting for an acknowledgement.

Errors

Returns an error if the broker is unreachable or rejects the offset commit request.

pub async fn shutdown(&self, timeout: Duration) -> bool

Gracefully shuts down any background resources owned by the offset store.