Repository navigation
docs: clarify Buf::remaining contract - #858
Open
SatvikMishra08 wants to merge 1 commit into
Open
SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
Document that remaining() is the exact unread length when below usize::MAX, that it must not change spontaneously through Buf alone, and how it interacts with advance (including usize::MAX saturation). Fixes tokio-rs#835
This branch has not been deployed
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
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.
Summary
Clarifies the
Buf::remainingcontract in rustdoc in response to #835.When
remaining()is less thanusize::MAX, it is the exact number of bytes still readable before the buffer is exhausted. Implementers must not letremaining()change spontaneously while the buffer is only used throughBuf, and afteradvance(cnt)(withcnt <= remaining()) the nextremaining()must beold - cnt, except when the true length saturates atusize::MAX(e.g. oversizedBuf::chainof clones).Also notes that adapters such as
BufMut::putrely on this for correctness.Docs-only; no API or behavior change.
Fixes #835
Test plan
cargo doc --no-deps(no broken intra-doc links)