diff options
Diffstat (limited to 'unicode-segmentation/README.md')
| -rw-r--r-- | unicode-segmentation/README.md | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/unicode-segmentation/README.md b/unicode-segmentation/README.md new file mode 100644 index 0000000..08fe6b8 --- /dev/null +++ b/unicode-segmentation/README.md @@ -0,0 +1,89 @@ +Iterators which split strings on Grapheme Cluster or Word boundaries, according +to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules. + +[](https://travis-ci.org/unicode-rs/unicode-segmentation) + +[Documentation](https://unicode-rs.github.io/unicode-segmentation/unicode_segmentation/index.html) + +```rust +use unicode_segmentation::UnicodeSegmentation; + +fn main() { + let s = "a̐éö̲\r\n"; + let g = UnicodeSegmentation::graphemes(s, true).collect::<Vec<&str>>(); + let b: &[_] = &["a̐", "é", "ö̲", "\r\n"]; + assert_eq!(g, b); + + let s = "The quick (\"brown\") fox can't jump 32.3 feet, right?"; + let w = s.unicode_words().collect::<Vec<&str>>(); + let b: &[_] = &["The", "quick", "brown", "fox", "can't", "jump", "32.3", "feet", "right"]; + assert_eq!(w, b); + + let s = "The quick (\"brown\") fox"; + let w = s.split_word_bounds().collect::<Vec<&str>>(); + let b: &[_] = &["The", " ", "quick", " ", "(", "\"", "brown", "\"", ")", " ", " ", "fox"]; + assert_eq!(w, b); +} +``` + +# no_std + +unicode-segmentation does not depend on libstd, so it can be used in crates +with the `#![no_std]` attribute. + +# crates.io + +You can use this package in your project by adding the following +to your `Cargo.toml`: + +```toml +[dependencies] +unicode-segmentation = "1.3.0" +``` + +# Change Log + +## 1.6.0 + +* [#72](https://github.com/unicode-rs/unicode-segmentation/pull/72) Upgrade to Unicode 12 + +## 1.5.0 + +* [#68](https://github.com/unicode-rs/unicode-segmentation/pull/68) Upgrade to Unicode 11 + +## 1.4.0 + +* [#56](https://github.com/unicode-rs/unicode-segmentation/pull/56) Upgrade to Unicode 10 + +## 1.3.0 + +* [#24](https://github.com/unicode-rs/unicode-segmentation/pull/24) Add support for sentence boundaries +* [#44](https://github.com/unicode-rs/unicode-segmentation/pull/44) Treat `gc=No` as a subset of `gc=N` + +## 1.2.1 + +* [#37](https://github.com/unicode-rs/unicode-segmentation/pull/37): + Fix panic in `provide_context`. +* [#40](https://github.com/unicode-rs/unicode-segmentation/pull/40): + Fix crash in `prev_boundary`. + +## 1.2.0 + +* New `GraphemeCursor` API allows random access and bidirectional iteration. +* Fixed incorrect splitting of certain emoji modifier sequences. + +## 1.1.0 + +* Add `as_str` methods to the iterator types. + +## 1.0.3 + +* Code cleanup and additional tests. + +## 1.0.1 + +* Fix a bug affecting some grapheme clusters containing Prepend characters. + +## 1.0.0 + +* Upgrade to Unicode 9.0.0. |