docs/stdlib/stream: correct comment in example code about discarded data #1474
Conversation
This file contains 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
In the example code the condition `done & self.stream.valid & ~self.stream.ready` is not sufficient to cause the payload to be discarded. That is because the done bit remains high. In case of a very slow stream, the first two quickly arriving serial transactions will never be lost, even if the first transaction has not been processed yet, when the second one arrives. However if a 3rd transaction arrives as well, then the 2nd transaction will be discarded.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1474 +/- ##
==========================================
- Coverage 91.12% 90.89% -0.24%
==========================================
Files 43 43
Lines 10990 11150 +160
Branches 2665 2712 +47
==========================================
+ Hits 10015 10135 +120
- Misses 805 849 +44
+ Partials 170 166 -4 ☔ View full report in Codecov by Sentry. |
purdeaandrei
force-pushed
the
correct_comment_in_stream_example_code
branch
from
74a6cf3
to
af26f96
Compare
purdeaandrei
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In the example code the condition
done & self.stream.valid & ~self.stream.readyis not sufficient to cause the payload to be discarded. That is because the done bit remains high. In case of a very slow stream, the first two quickly arriving serial transactions will never be lost, even if the first transaction has not been processed yet, when the second one arrives.However if a 3rd transaction arrives as well, then the 2nd transaction will be discarded.
See here for the done bit being sticky, and the 2nd transaction (out of two) not being lost:
See here for the case when the 3rd transaction causes the 2nd transaction to be discared:
