Determine displayed width of char
and str
types according to Unicode Standard Annex #11,
other portions of the Unicode standard, and common implementations of POSIX wcwidth()
.
This crate is #![no_std]
.
use unicode_width::UnicodeWidthStr;
fn main() {
let teststr = "Hello, world!";
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. Such emoji ZWJ sequences are considered to have the sum of the widths of their constituent parts:
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
}
Additionally, defective combining character sequences and nonstandard Korean jamo sequences may be rendered with a different width than what this crate says. (This is not an exhaustive list.)
You can use this package in your project by adding the following
to your Cargo.toml
:
[dependencies]
unicode-width = "0.1.11"