digest: Clarify panic safety of (Block)Digest::finish
#2185
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
Although the buffer does initially contain the pending data, `pending` is a confusing name for it.
Istead of forcing callers to slice the buffer to the block length and then asserting that they did so, just have `BlockContext::finish` do the slicing itself. (It already was.)
Help the compiler understand the range of `len_len` so it can optimize away some bounds checks.
Clarify that the slicing will panic if (and only if) the function's precondition is violated. This is a step towards providing an non-panicking variant of the API.
Return an error instead of panic when too much input is processed by a `BlockContext`, or when the precondition of `BlockContext::finish` is violated. Jump through some hoops to get the compiler to prefer the non-error path. This is a step towards providing an non-panicking variant of the API.
briansmith
force-pushed
the
b/digest-infallible-1
branch
from
b4d440d to
b967bdf
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2185 +/- ##
==========================================
- Coverage 96.95% 96.90% -0.05%
==========================================
Files 154 154
Lines 20216 20239 +23
Branches 462 461 -1
==========================================
+ Hits 19600 19613 +13
- Misses 511 520 +9
- Partials 105 106 +1 ☔ View full report in Codecov by Sentry. |
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.
See the individual commit messages for details. This is a step towards providing a never-panicking variant of the API.