unicode_titlecase 1.0.1

A crate to add Unicode titlecase options to chars
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Unicode Titlecase

Unicode titlecasing operations for chars. The crate supports has additional functionality to
support the TR/AZ locale. 


## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
unicode_titlecase = "1.0.1"
```

## Features/Dependencies


There are no dependencies for this crate. The only feature is "std" which is used to add 
```std::Display``` on the iterators. This enables code like 
```'ffl'.to_titlecase().to_string()```. 

## Usage


To turn a ```char``` into a its titlecase equivalent ```[char; 3]```array:
```rust
use unicode_titlecase::to_titlecase;

assert_eq!(to_titlecase('A'), ['A', '\0', '\0']);
assert_eq!(to_titlecase('DŽ'), ['Dž', '\0', '\0']);
assert_eq!(to_titlecase('ffl'), ['F', 'f', 'l']);
```

Or use the iterator version that follows the same format as the std library. The crate defines
a ```Trait``` that is implemented on ```char```:

```rust
use unicode_titlecase::TitleCase;
assert_eq!('i'.to_titlecase().to_string(), "I");
assert_eq!('A'.to_titlecase().to_string(), "A");
assert_eq!('DŽ'.to_titlecase().to_string(), "Dž");
assert_eq!('ffl'.to_titlecase().to_string(), "Ffl");
```

### Locale

The TR and AZ locales have different rules for how to titlecase certain characters. 
The ```to_titlecase``` functions assume the locale is neither of these locations. For conversions
using TR or AZ locales the following functions are also provided:

```rust
use unicode_titlecase::to_titlecase_tr_or_az;
assert_eq!(to_titlecase_tr_or_az('i'), ['İ', '\0', '\0']);
```
And as an iterator:
```rust
use unicode_titlecase::TitleCase;
assert_eq!('i'.to_titlecase_tr_or_az().to_string(), "İ");
```

## License


`unicode_titlecase` is licensed under the [MIT License](LICENSE)