diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-19 00:47:55 +0000 |
commit | 26a029d407be480d791972afb5975cf62c9360a6 (patch) | |
tree | f435a8308119effd964b339f76abb83a57c29483 /third_party/rust/icu_segmenter/README.md | |
parent | Initial commit. (diff) | |
download | firefox-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/icu_segmenter/README.md')
-rw-r--r-- | third_party/rust/icu_segmenter/README.md | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/third_party/rust/icu_segmenter/README.md b/third_party/rust/icu_segmenter/README.md new file mode 100644 index 0000000000..00a3aa79a2 --- /dev/null +++ b/third_party/rust/icu_segmenter/README.md @@ -0,0 +1,106 @@ +# icu_segmenter [![crates.io](https://img.shields.io/crates/v/icu_segmenter)](https://crates.io/crates/icu_segmenter) + +<!-- cargo-rdme start --> + +Segment strings by lines, graphemes, words, and sentences. + +This module is published as its own crate ([`icu_segmenter`](https://docs.rs/icu_segmenter/latest/icu_segmenter/)) +and as part of the [`icu`](https://docs.rs/icu/latest/icu/) crate. See the latter for more details on the ICU4X project. + +This module contains segmenter implementation for the following rules. + +- Line segmenter that is compatible with [Unicode Standard Annex #14][UAX14], _Unicode Line + Breaking Algorithm_, with options to tailor line-breaking behavior for CSS [`line-break`] and + [`word-break`] properties. +- Grapheme cluster segmenter, word segmenter, and sentence segmenter that are compatible with + [Unicode Standard Annex #29][UAX29], _Unicode Text Segmentation_. + +[UAX14]: https://www.unicode.org/reports/tr14/ +[UAX29]: https://www.unicode.org/reports/tr29/ +[`line-break`]: https://drafts.csswg.org/css-text-3/#line-break-property +[`word-break`]: https://drafts.csswg.org/css-text-3/#word-break-property + +## Examples + +### Line Break + +Find line break opportunities: + +```rust +use icu::segmenter::LineSegmenter; + +let segmenter = LineSegmenter::new_auto(); + +let breakpoints: Vec<usize> = segmenter + .segment_str("Hello World. Xin chào thế giới!") + .collect(); +assert_eq!(&breakpoints, &[0, 6, 13, 17, 23, 29, 36]); +``` + +See [`LineSegmenter`] for more examples. + +### Grapheme Cluster Break + +Find all grapheme cluster boundaries: + +```rust +use icu::segmenter::GraphemeClusterSegmenter; + +let segmenter = GraphemeClusterSegmenter::new(); + +let breakpoints: Vec<usize> = segmenter + .segment_str("Hello World. Xin chào thế giới!") + .collect(); +assert_eq!( + &breakpoints, + &[ + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, + 19, 21, 22, 23, 24, 25, 28, 29, 30, 31, 34, 35, 36 + ] +); +``` + +See [`GraphemeClusterSegmenter`] for more examples. + +### Word Break + +Find all word boundaries: + +```rust +use icu::segmenter::WordSegmenter; + +let segmenter = WordSegmenter::new_auto(); + +let breakpoints: Vec<usize> = segmenter + .segment_str("Hello World. Xin chào thế giới!") + .collect(); +assert_eq!( + &breakpoints, + &[0, 5, 6, 11, 12, 13, 16, 17, 22, 23, 28, 29, 35, 36] +); +``` + +See [`WordSegmenter`] for more examples. + +### Sentence Break + +Segment the string into sentences: + +```rust +use icu::segmenter::SentenceSegmenter; + +let segmenter = SentenceSegmenter::new(); + +let breakpoints: Vec<usize> = segmenter + .segment_str("Hello World. Xin chào thế giới!") + .collect(); +assert_eq!(&breakpoints, &[0, 13, 36]); +``` + +See [`SentenceSegmenter`] for more examples. + +<!-- cargo-rdme end --> + +## More Information + +For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x). |