[rustc.git] / vendor / unicode-normalization / README.md

# unicode-normalization

[![Build Status](https://travis-ci.org/unicode-rs/unicode-normalization.svg)](https://travis-ci.org/unicode-rs/unicode-normalization)
[![Docs](https://docs.rs/unicode-normalization/badge.svg)](https://docs.rs/unicode-normalization/)

Unicode character composition and decomposition utilities
as described in
[Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).

This crate requires Rust 1.36+.

```rust
extern crate unicode_normalization;

use unicode_normalization::char::compose;
use unicode_normalization::UnicodeNormalization;

fn main() {
    assert_eq!(compose('A','\u{30a}'), Some('Å'));

    let s = "ÅΩ";
    let c = s.nfc().collect::<String>();
    assert_eq!(c, "ÅΩ");
}
```

## crates.io

You can use this package in your project by adding the following
to your `Cargo.toml`:

```toml
[dependencies]
unicode-normalization = "0.1.16"
```

## `no_std` + `alloc` support

This crate is completely `no_std` + `alloc` compatible. This can be enabled by disabling the `std` feature, i.e. specifying `default-features = false` for this crate on your `Cargo.toml`.
Commit	Line	Data
dfeec247 XL	1	# unicode-normalization
	2
	3	[![Build Status](https://travis-ci.org/unicode-rs/unicode-normalization.svg)](https://travis-ci.org/unicode-rs/unicode-normalization)
	4	[![Docs](https://docs.rs/unicode-normalization/badge.svg)](https://docs.rs/unicode-normalization/)
	5
abe05a73 XL	6	Unicode character composition and decomposition utilities
	7	as described in
	8	[Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).
	9
dfeec247	10	This crate requires Rust 1.36+.
abe05a73 XL	11
	12	```rust
	13	extern crate unicode_normalization;
	14
	15	use unicode_normalization::char::compose;
	16	use unicode_normalization::UnicodeNormalization;
	17
	18	fn main() {
	19	assert_eq!(compose('A','\u{30a}'), Some('Å'));
8faf50e0	20
abe05a73 XL	21	let s = "ÅΩ";
	22	let c = s.nfc().collect::<String>();
	23	assert_eq!(c, "ÅΩ");
	24	}
	25	```
	26
dfeec247	27	## crates.io
abe05a73 XL	28
	29	You can use this package in your project by adding the following
	30	to your `Cargo.toml`:
	31
	32	```toml
	33	[dependencies]
5869c6ff	34	unicode-normalization = "0.1.16"
abe05a73	35	```
f035d41b XL	36
	37	## `no_std` + `alloc` support
	38
	39	This crate is completely `no_std` + `alloc` compatible. This can be enabled by disabling the `std` feature, i.e. specifying `default-features = false` for this crate on your `Cargo.toml`.