Skip to content

docs: clarify +1 offset semantics for store_offset #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
funcpp wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify +1 offset semantics for store_offset #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/consumer/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,17 +300,20 @@ where
/// from the message and adds 1 to the offset of the message.
fn commit_message(&self, message: &BorrowedMessage<'_>, mode: CommitMode) -> KafkaResult<()>;

/// Stores offset to be used on the next (auto)commit. When
/// Stores offset `offset` + 1 to be used on the next (auto)commit. When
/// using this `enable.auto.offset.store` should be set to `false` in the
/// config.
fn store_offset(&self, topic: &str, partition: i32, offset: i64) -> KafkaResult<()>;

/// Like [`Consumer::store_offset`], but the offset to store is derived from
/// the provided message.
/// the provided message: the message's offset + 1.
fn store_offset_from_message(&self, message: &BorrowedMessage<'_>) -> KafkaResult<()>;

/// Store offsets to be used on the next (auto)commit. When using this
/// `enable.auto.offset.store` should be set to `false` in the config.
///
/// Unlike [`Consumer::store_offset`], the offsets are stored as is; they
/// will NOT be + 1.
fn store_offsets(&self, tpl: &TopicPartitionList) -> KafkaResult<()>;

/// Returns the current topic subscription.
Expand Down