[rustc.git] / src / vendor / unicode-width / README.md

# unicode-width

Determine displayed width of `char` and `str` types according to
[Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
rules.

[![Build Status](https://travis-ci.org/unicode-rs/unicode-width.svg)](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);
}
```

## 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.5"
```
Commit	Line	Data
8bb4bdeb XL	1	# unicode-width
	2
	3	Determine displayed width of `char` and `str` types according to
	4	[Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
	5	rules.
	6
	7	[![Build Status](https://travis-ci.org/unicode-rs/unicode-width.svg)](https://travis-ci.org/unicode-rs/unicode-width)
	8
	9	[Documentation](https://unicode-rs.github.io/unicode-width/unicode_width/index.html)
	10
	11	```rust
	12	extern crate unicode_width;
	13
	14	use unicode_width::UnicodeWidthStr;
	15
	16	fn main() {
	17	let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
	18	let width = UnicodeWidthStr::width(teststr);
	19	println!("{}", teststr);
	20	println!("The above string is {} columns wide.", width);
	21	let width = teststr.width_cjk();
	22	println!("The above string is {} columns wide (CJK).", width);
	23	}
	24	```
	25
	26	## features
	27
	28	unicode-width does not depend on libstd, so it can be used in crates
	29	with the `#![no_std]` attribute.
	30
	31	## crates.io
	32
	33	You can use this package in your project by adding the following
	34	to your `Cargo.toml`:
	35
	36	```toml
	37	[dependencies]
8faf50e0	38	unicode-width = "0.1.5"
8bb4bdeb	39	```