summaryrefslogtreecommitdiffstats
path: root/third_party/rust/bhttp/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /third_party/rust/bhttp/README.md
parentInitial commit. (diff)
downloadthunderbird-upstream.tar.xz
thunderbird-upstream.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--third_party/rust/bhttp/README.md25
1 files changed, 25 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..2a6bc21b6e
--- /dev/null
+++ b/third_party/rust/bhttp/README.md
@@ -0,0 +1,25 @@
+# Binary HTTP Messages
+
+This is a rust implementation of [Binary HTTP
+Messages](https://www.rfc-editor.org/rfc/rfc9292.html).
+
+## 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.