summaryrefslogtreecommitdiffstats
path: root/third_party/rust/utf8_iter/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/utf8_iter/README.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/utf8_iter/README.md')
-rw-r--r--third_party/rust/utf8_iter/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/third_party/rust/utf8_iter/README.md b/third_party/rust/utf8_iter/README.md
new file mode 100644
index 0000000000..c6290861ae
--- /dev/null
+++ b/third_party/rust/utf8_iter/README.md
@@ -0,0 +1,46 @@
+# utf8_iter
+
+[![crates.io](https://img.shields.io/crates/v/utf8_iter.svg)](https://crates.io/crates/utf8_iter)
+[![docs.rs](https://docs.rs/utf8_iter/badge.svg)](https://docs.rs/utf8_iter/)
+
+utf8_iter provides iteration by `char` over potentially-invalid UTF-8 `&[u8]`
+such that UTF-8 errors are handled according to the WHATWG Encoding Standard.
+
+Key parts of the code are copypaste from the UTF-8 to UTF-16 conversion code
+in `encoding_rs`, which was optimized for speed in the case of valid input.
+The implementation here uses the structure that was found to be fast in the
+`encoding_rs` context but the structure hasn't been benchmarked in this
+context.
+
+This is a `no_std` crate.
+
+## Licensing
+
+TL;DR: `Apache-2.0 OR MIT`
+
+Please see the file named
+[COPYRIGHT](https://github.com/hsivonen/utf8_iter/blob/master/COPYRIGHT).
+
+## Documentation
+
+Generated [API documentation](https://docs.rs/utf8_iter/) is available
+online.
+
+## Release Notes
+
+### 1.0.3
+
+* Fix an error in documentation.
+
+### 1.0.2
+
+* `char_indices()` implementation.
+
+### 1.0.1
+
+* `as_slice()` method.
+* Implement `DoubleEndedIterator`
+
+### 1.0.0
+
+The initial release.