diff options
Diffstat (limited to 'third_party/rust/bhttp/README.md')
| -rw-r--r-- | third_party/rust/bhttp/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/third_party/rust/bhttp/README.md b/third_party/rust/bhttp/README.md new file mode 100644 index 0000000000..44e86164a9 --- /dev/null +++ b/third_party/rust/bhttp/README.md @@ -0,0 +1,28 @@ +# Binary HTTP Messages + +This is a rust implementation of [Binary HTTP +Messages](https://httpwg.org/http-extensions/draft-ietf-httpbis-binary-message.html). + +This work is undergoing active revision in the IETF and so are these +implementations. Use at your own risk. + +## Using + +The API documentation is currently sparse, but the API is fairly small and +descriptive. + +The `bhttp` crate has the following features: + +- `read-bhttp` enables parsing of binary HTTP messages. This is enabled by + default. + +- `write-bhttp` enables writing of binary HTTP messages. This is enabled by + default. + +- `read-http` enables a simple HTTP/1.1 message parser. This parser is fairly + basic and is not recommended for production use. Getting an HTTP/1.1 parser + right is a massive enterprise; this one only does the basics. This is + disabled by default. + +- `write-http` enables writing of HTTP/1.1 messages. This is disabled by + default. |