Publicly document MutableBinaryViewArray invariants #20534
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
These invariants are referenced from the safety documentation of several publicly-exposed methods. This information should therefore be public so that callers can ensure correct usage.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #20534 +/- ##
==========================================
- Coverage 79.04% 79.04% -0.01%
==========================================
Files 1563 1564 +1
Lines 220798 220612 -186
Branches 2502 2502
==========================================
- Hits 174522 174372 -150
+ Misses 45702 45666 -36
Partials 574 574 ☔ View full report in Codecov by Sentry. |
ritchie46
reviewed
Jan 3, 2025
| // - Each view must point to a valid slice of a buffer | ||
| // - `total_buffer_len` must be equal to `completed_buffers.iter().map(Vec::len).sum()` | ||
| // - `total_bytes_len` must be equal to `views.iter().map(View::len).sum()` | ||
| /// # Safety invariants |
There was a problem hiding this comment.
Can we just call them Invariants?
Suggested change
| /// # Safety invariants | |
| /// # Invariants |
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.
These invariants are referenced from the safety documentation of several publicly-exposed methods. This information should therefore be public so that callers can ensure correct usage.