Skip to main content

OffsetManager

Struct OffsetManager 

Source
pub struct OffsetManager<B: StateBackend, S: OffsetStore> { /* private fields */ }
Expand description

Main offset manager

Coordinates offset tracking, committing, and recovery for Kafka consumers.

§Features

  • Per-partition offset tracking
  • Watermark-based commit strategies
  • Checkpoint integration
  • Offset lag monitoring
  • Automatic and manual commit modes

Implementations§

Source§

impl<B: StateBackend, S: OffsetStore> OffsetManager<B, S>

Source

pub fn new( consumer_group: String, backend: Arc<B>, store: Arc<S>, strategy: OffsetCommitStrategy, ) -> Self

Create a new offset manager

§Arguments
  • consumer_group - Consumer group ID
  • backend - State backend for checkpointing
  • store - Offset storage implementation
  • strategy - Commit strategy
Source

pub async fn update_offset( &mut self, topic: &str, partition: u32, offset: i64, ) -> StateResult<()>

Update offset for a partition

§Arguments
  • topic - Kafka topic
  • partition - Partition number
  • offset - New offset value
§Returns
  • Ok(()) - Offset updated
  • Err(StateError) - Update failed
Source

pub async fn update_offset_with_watermark( &mut self, topic: &str, partition: u32, offset: i64, high_watermark: i64, ) -> StateResult<()>

Update offset with high watermark

Source

pub async fn get_offset( &self, topic: &str, partition: u32, ) -> StateResult<Option<i64>>

Get current offset for a partition

Returns the committed offset, or None if no offset has been committed.

Source

pub async fn get_offset_info( &self, topic: &str, partition: u32, ) -> StateResult<Option<OffsetInfo>>

Get offset info (includes metadata and watermarks)

Source

pub async fn commit(&mut self) -> StateResult<usize>

Commit all pending offsets

§Returns
  • Ok(committed_count) - Number of offsets committed
  • Err(StateError) - Commit failed
Source

pub async fn lag( &self, topic: &str, partition: u32, high_watermark: i64, ) -> StateResult<i64>

Calculate offset lag for a partition

§Arguments
  • topic - Kafka topic
  • partition - Partition number
  • high_watermark - Current high watermark (latest offset in partition)
§Returns
  • Ok(lag) - Offset lag (high_watermark - current_offset)
  • Err(StateError) - Calculation failed
Source

pub async fn total_lag(&self) -> StateResult<i64>

Get total lag across all partitions

Source

pub async fn restore(&mut self) -> StateResult<usize>

Restore offsets from storage

Loads all committed offsets for the consumer group from the offset store.

§Returns
  • Ok(restored_count) - Number of offsets restored
  • Err(StateError) - Restore failed
Source

pub async fn reset_offset( &mut self, topic: &str, partition: u32, strategy: OffsetResetStrategy, partition_high_watermark: Option<i64>, ) -> StateResult<i64>

Reset offset for a partition

§Arguments
  • topic - Kafka topic
  • partition - Partition number
  • strategy - Reset strategy (earliest, latest, specific offset, etc.)
  • partition_high_watermark - Current high watermark for the partition
§Returns
  • Ok(new_offset) - The new offset value
  • Err(StateError) - Reset failed
Source

pub async fn notify_watermark( &mut self, watermark: Watermark, ) -> StateResult<bool>

Notify manager of watermark advancement (for OnWatermark strategy)

§Arguments
  • watermark - New watermark value
§Returns
  • Ok(committed) - True if commit occurred
  • Err(StateError) - Notification failed
Source

pub async fn stats(&self) -> OffsetStats

Get statistics

Source

pub async fn get_all_committed(&self) -> HashMap<TopicPartition, OffsetInfo>

Get all committed offsets

Source

pub async fn get_all_pending(&self) -> HashMap<TopicPartition, OffsetInfo>

Get all pending offsets (not yet committed)

Source

pub async fn clear(&mut self) -> StateResult<()>

Clear all offsets for this consumer group

Auto Trait Implementations§

§

impl<B, S> !RefUnwindSafe for OffsetManager<B, S>

§

impl<B, S> !UnwindSafe for OffsetManager<B, S>

§

impl<B, S> Freeze for OffsetManager<B, S>
where Arc<B>: Freeze, Arc<S>: Freeze,

§

impl<B, S> Send for OffsetManager<B, S>
where Arc<B>: Send, Arc<S>: Send,

§

impl<B, S> Sync for OffsetManager<B, S>
where Arc<B>: Sync, Arc<S>: Sync,

§

impl<B, S> Unpin for OffsetManager<B, S>
where Arc<B>: Unpin, Arc<S>: Unpin,

§

impl<B, S> UnsafeUnpin for OffsetManager<B, S>
where Arc<B>: UnsafeUnpin, Arc<S>: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more