chore(sdk): IggyConsumer docs - #3913
Open
haubur wants to merge 4 commits into
Open
Conversation
|
Thanks for the PR. It is labeled Slash commands (own line, regular comment) move it around the queue:
See CONTRIBUTING.md for details. |
hubcio
requested changes
Aug 18, 2026
hubcio
left a comment
hubcio
left a comment
Contributor
There was a problem hiding this comment.
most behavioral claims here actually check out against the code, which is rare for a docs PR.
the three crash-safety spots (the auto-commit advice, the guarantees section, the manual-commit example) state the opposite of what the code does, and those are exactly the lines people will build on. the rest is wording cleanup.
really good work @haubur
github-actions
Bot
added
S-waiting-on-author
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3913 +/- ##
=============================================
- Coverage 83.67% 65.17% -18.51%
Complexity 1358 1358
=============================================
Files 1212 1212
Lines 165138 141315 -23823
Branches 132612 108915 -23697
=============================================
- Hits 138181 92101 -46080
- Misses 23308 45498 +22190
- Partials 3649 3716 +67
🚀 New features to boost your workflow:
|
haubur
force-pushed
the
chore/sdk-docs-consumer-producer
branch
from
August 18, 2026 16:42
4c6fc47 to
67d47d3
Compare
Contributor
Author
|
/ready |
github-actions
Bot
added
S-waiting-on-review
hubcio
approved these changes
Aug 19, 2026
ethanlin01x
reviewed
Aug 20, 2026
| /// [`allow_replay()`], which turns that filter off. | ||
| /// - **Delivering at-least-once.** If you cannot tolerate missing any messages, use [`AutoCommit::Disabled`] | ||
| /// and store the offset using [`Self::store_offset()`] after handling a message. | ||
| /// Alternatively, you can use [`IggyConsumerMessageExt::consumer_messages()`] with [`AutoCommitAfter`]. |
Contributor
There was a problem hiding this comment.
Suggested change
| /// Alternatively, you can use [`IggyConsumerMessageExt::consumer_messages()`] with [`AutoCommitAfter`]. | |
| /// Alternatively, you can use [`IggyConsumerMessageExt::consume_messages`] with [`AutoCommitAfter`]. |
| /// [`allow_replay()`], which turns that filter off. | ||
| /// - **Delivering at-least-once.** If you cannot tolerate missing any messages, use [`AutoCommit::Disabled`] | ||
| /// and store the offset using [`Self::store_offset()`] after handling a message. | ||
| /// Alternatively, you can use [`IggyConsumerMessageExt::consumer_messages()`] with [`AutoCommitAfter`]. |
Contributor
There was a problem hiding this comment.
This path does not give at-least-once delivery. In consumer_ext/consumer_message_ext.rs:91 a handler error is only logged, and send_store_offset() runs right after it either way, so a failed message still gets committed. I would drop this sentence and keep only the AutoCommit::Disabled advice above.
|
|
||
| // Absent streams or topics are not necessarily permanent failures. | ||
| // It may happen that get_stream/ get_topic races the initial setup of the stream/ topic. | ||
| // Retry for init_retires times, while waiting interval between retries. |
Contributor
There was a problem hiding this comment.
init_retires -> init_retries
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3912
Relates #3306
Local Execution
AI Usage
None