seanmonstar / httparse

A push parser for the HTTP 1.x protocol in Rust.
https://docs.rs/httparse
Apache License 2.0
567 stars 111 forks source link

Resize headers on partial parse #160

Open tgnottingham opened 2 months ago

tgnottingham commented 2 months ago

The main benefit of this is that it enables you to get the parsed headers from partial results when using uninitialized headers. Prior to this, on a partial result, the headers in a request or response would be replaced with the original slice passed when creating the request or response (typically an empty slice when using uninitialized headers), rather than the initialized portion of the uninitialized headers passed into the parse function call.

It also makes handling partial parse results more convenient in general since you can iterate over the headers in the request or response without having to manually determine the last element.

This is technically a breaking change, though it seems unlikely that any client would depend on the previous behavior in a way that the change would break their code.

tgnottingham commented 2 months ago

I realized that there is a use case where a client might have depended on the previous behavior -- repeatedly using the same Request/Response until the result is Complete. With this change, if a later parse input has more header fields than a previous input, it will result in a TooManyHeaders error because the previous partial parse shrunk the headers.

Of course, even without my change, Complete Requests/Responses can't be reused for the exact same reason. Still, I'm guessing the change in behavior in the Partial case is enough to dissuade accepting this PR. Bummer.