diff options
Diffstat (limited to 'unicode-width/README.md')
| -rw-r--r-- | unicode-width/README.md | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/unicode-width/README.md b/unicode-width/README.md deleted file mode 100644 index 595e163..0000000 --- a/unicode-width/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# unicode-width - -Determine displayed width of `char` and `str` types according to -[Unicode Standard Annex #11][UAX11] rules. - -[UAX11]: http://www.unicode.org/reports/tr11/ - -[](https://travis-ci.org/unicode-rs/unicode-width) - -[Documentation](https://unicode-rs.github.io/unicode-width/unicode_width/index.html) - -```rust -extern crate unicode_width; - -use unicode_width::UnicodeWidthStr; - -fn main() { - let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!"; - let width = UnicodeWidthStr::width(teststr); - println!("{}", teststr); - println!("The above string is {} columns wide.", width); - let width = teststr.width_cjk(); - println!("The above string is {} columns wide (CJK).", width); -} -``` - -**NOTE:** The computed width values may not match the actual rendered column -width. For example, the woman scientist emoji comprises of a woman emoji, a -zero-width joiner and a microscope emoji. - -```rust -extern crate unicode_width; -use unicode_width::UnicodeWidthStr; - -fn main() { - assert_eq!(UnicodeWidthStr::width("👩"), 2); // Woman - assert_eq!(UnicodeWidthStr::width("🔬"), 2); // Microscope - assert_eq!(UnicodeWidthStr::width("👩🔬"), 4); // Woman scientist -} -``` - -See [Unicode Standard Annex #11][UAX11] for precise details on what is and isn't -covered by this crate. - -## features - -unicode-width 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-width = "0.1.7" -``` |