summaryrefslogtreecommitdiffstats
path: root/vendor/futf/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/futf/README.md
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/futf/README.md')
-rw-r--r--vendor/futf/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/vendor/futf/README.md b/vendor/futf/README.md
new file mode 100644
index 000000000..325b2e74d
--- /dev/null
+++ b/vendor/futf/README.md
@@ -0,0 +1,18 @@
+# futf
+
+[![Build Status](https://travis-ci.org/servo/futf.svg?branch=master)](https://travis-ci.org/kmcallister/futf)
+
+futf is a library for *flexible* UTF-8, or UTF-8 *fragments*. I don't know.
+Check out the [API documentation](http://doc.servo.org/futf/index.html).
+
+Anyway, it takes an index into a byte buffer and tells you things about the
+UTF-8 codepoint containing that byte. It can deal with incomplete codepoint
+prefixes / suffixes at the ends of a buffer, which is useful for incremental
+I/O. It can also handle UTF-16 surrogate code units encoded in the manner of
+[CESU-8][] or [WTF-8][].
+
+This is a low-level helper for [tendril][] that might be useful more generally.
+
+[CESU-8]: http://www.unicode.org/reports/tr26/
+[WTF-8]: http://simonsapin.github.io/wtf-8/
+[tendril]: https://github.com/kmcallister/tendril