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

# unicode-xid

Determine if a `char` is a valid identifier for a parser and/or lexer according to
[Unicode Standard Annex #31](http://www.unicode.org/reports/tr31/) rules.

[![Build Status](https://img.shields.io/github/workflow/status/unicode-rs/unicode-xid/CI/master)](https://github.com/unicode-rs/unicode-xid/actions?query=branch%3Amaster)

[Documentation](https://unicode-rs.github.io/unicode-xid/unicode_xid/index.html)

```rust
extern crate unicode_xid;

use unicode_xid::UnicodeXID;

fn main() {
    let ch = 'a';
    println!("Is {} a valid start of an identifier? {}", ch, UnicodeXID::is_xid_start(ch));
}
```

# features

unicode-xid supports a `no_std` feature. This eliminates dependence
on std, and instead uses equivalent functions from core.


# changelog

## 0.2.2

- Add an ASCII fast-path

## 0.2.1

- Update to Unicode 13.0.0
- Speed up lookup

## 0.2.0

- Update to Unicode 12.1.0.

## 0.1.0

- Initial release.
Commit	Line	Data
83c7162d XL	1	# unicode-xid
	2
	3	Determine if a `char` is a valid identifier for a parser and/or lexer according to
	4	[Unicode Standard Annex #31](http://www.unicode.org/reports/tr31/) rules.
	5
923072b8	6	[![Build Status](https://img.shields.io/github/workflow/status/unicode-rs/unicode-xid/CI/master)](https://github.com/unicode-rs/unicode-xid/actions?query=branch%3Amaster)
83c7162d XL	7
	8	[Documentation](https://unicode-rs.github.io/unicode-xid/unicode_xid/index.html)
	9
	10	```rust
	11	extern crate unicode_xid;
	12
	13	use unicode_xid::UnicodeXID;
	14
	15	fn main() {
	16	let ch = 'a';
	17	println!("Is {} a valid start of an identifier? {}", ch, UnicodeXID::is_xid_start(ch));
	18	}
	19	```
	20
	21	# features
	22
	23	unicode-xid supports a `no_std` feature. This eliminates dependence
	24	on std, and instead uses equivalent functions from core.
	25
e1599b0c XL	26
	27	# changelog
	28
17df50a5 XL	29	## 0.2.2
	30
	31	- Add an ASCII fast-path
	32
	33	## 0.2.1
	34
	35	- Update to Unicode 13.0.0
	36	- Speed up lookup
	37
e1599b0c XL	38	## 0.2.0
	39
	40	- Update to Unicode 12.1.0.
	41
	42	## 0.1.0
	43
	44	- Initial release.