Repository navigation
Rewrite the README for 0.4.0 - #87
Merged
Merged
Conversation
Describes the library as it is once #74-#86 are merged: requests and responses through TryParseRequestHeader / TryParseResponseHeader, the body-framing helpers, chunked decoding (partial chunks, the trailer cap), every ParserLimits field with its default and status code (including AllowBareLf and MaxTotalTrailerBytes), the two parser tiers, a summary of the hardening with a link to SECURITY.md, the tests, and what changes when migrating to 0.4.0. Glyph11.Native and Glyph11.Pico are marked discontinued. Also fixes the chunked example, which listed a ChunkResult.Error that does not exist (malformed framing throws).
# Conflicts: # README.md
MDA2AV
marked this pull request as ready for review
November 3, 2026 19:46
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.
Rewrites the README for 0.4.0, the state after #74–#86 are merged. Merge it last.
Why
Each PR in the series updated only its own lines of the README. Merged together, those lines still left the README:
ParserLimits, the two parser tiers or the error codes;ChunkResult.Errorin the chunked example that doesn't exist (malformed framing throws).What's in it
TryParseRequestHeader: whattrue,falseandHttpParseExceptionmean, and which status code each error carries (400, 431 or 505). It also notes that the parser clears its target.DetectBodyFraming, andDetectResponseBodyFramingwith the request method it needs. It covers Content-Length agreement, saturation atlong.MaxValue, andContentLengthBodyReader.ChunkedBodyValidator.ParserLimitsfield, with its default and the status code when exceeded. That includesAllowBareLfandMaxTotalTrailerBytes.UltraHardenedParservsFlexibleParser, with a summary of the hardening that links toSECURITY.md.TryExtract*methods (drop the+ 1), self-clearing targets, 400 vs 505 for versions, partial chunks, and the throwing framing helpers.Glyph11.NativeandGlyph11.Pico.The benchmark tables are unchanged. The multi-segment caption now says only the header block is linearized (#86).
Merge order
#74–#86 are merged. I merged main into this branch and kept this PR's README, so the README is the only file that differs from main.
A new run of the benchmark harness on the merged code stays within 4% of the tables (for example 118 ns vs 120 ns, and 722 ns vs 750 ns), so the numbers stand.