70 lines
2.7 KiB
Markdown
70 lines
2.7 KiB
Markdown
# `unicode-width`
|
||
|
||
[](https://github.com/unicode-rs/unicode-width/actions/workflows/rust.yml)
|
||
[](https://crates.io/crates/unicode-width)
|
||
[](https://docs.rs/unicode-width/)
|
||
|
||
Determine displayed width of `char` and `str` types according to [Unicode Standard Annex #11][UAX11]
|
||
and other portions of the Unicode standard.
|
||
|
||
This crate is `#![no_std]`.
|
||
|
||
[UAX11]: http://www.unicode.org/reports/tr11/
|
||
|
||
```rust
|
||
use unicode_width::UnicodeWidthStr;
|
||
|
||
fn main() {
|
||
let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
|
||
let width = teststr.width();
|
||
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, many Brahmic scripts like Devanagari have complex rendering rules
|
||
which this crate does not currently handle (and will never fully handle, because
|
||
the exact rendering depends on the font):
|
||
|
||
```rust
|
||
extern crate unicode_width;
|
||
use unicode_width::UnicodeWidthStr;
|
||
|
||
fn main() {
|
||
assert_eq!("क".width(), 1); // Devanagari letter Ka
|
||
assert_eq!("ष".width(), 1); // Devanagari letter Ssa
|
||
assert_eq!("क्ष".width(), 2); // Ka + Virama + Ssa
|
||
}
|
||
```
|
||
|
||
Additionally, [defective combining character sequences](https://unicode.org/glossary/#defective_combining_character_sequence)
|
||
and nonstandard [Korean jamo](https://unicode.org/glossary/#jamo) sequences may
|
||
be rendered with a different width than what this crate says. (This is not an
|
||
exhaustive list.) For a list of what this crate *does* handle, see
|
||
[docs.rs](https://docs.rs/unicode-width/latest/unicode_width/#rules-for-determining-width).
|
||
|
||
## crates.io
|
||
|
||
You can use this package in your project by adding the following
|
||
to your `Cargo.toml`:
|
||
|
||
```toml
|
||
[dependencies]
|
||
unicode-width = "0.1.11"
|
||
```
|
||
|
||
|
||
## Changelog
|
||
|
||
|
||
### 0.2.0
|
||
|
||
- Treat `\n` as width 1 (#60)
|
||
- Treat ambiguous `Modifier_Letter`s as narrow (#63)
|
||
- Support `Grapheme_Cluster_Break=Prepend` (#62)
|
||
- Support lots of ligatures (#53)
|
||
|
||
Note: If you are using `unicode-width` for linebreaking, the change treating `\n` as width 1 _may cause behavior changes_. It is recommended that in such cases you feed already-line segmented text to `unicode-width`. In other words, please apply higher level control character based line breaking protocols before feeding text to `unicode-width`. Relying on any character producing a stable width in this crate is likely the sign of a bug.
|