docs(header): correct HeaderMap max capacity and clarify reserve panic - #865
Open
ChrisJr404 wants to merge 1 commit into
Open
docs(header): correct HeaderMap max capacity and clarify reserve panic#865ChrisJr404 wants to merge 1 commit into
ChrisJr404 wants to merge 1 commit into
Conversation
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.
Closes #603.
The
# Limitationssection said aHeaderMapcan hold 32,768 entries, but inserts actually start failing at 24,576 (that isusable_capacity(MAX_SIZE)), which is the number the original reporter hit. I corrected the count and pointed the section at the fallibletry_insert/try_append/try_reservemethods so there is a clear way to stay under the limit without panicking.I also reworded the
reservepanic note. It referenced the privateMAX_SIZEconstant, so it now points at the type docs andtry_reserveinstead.Docs only, no behavior change.