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:

[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 'ﬄ'.to_titlecase().to_string().

Usage

To turn a char into a its titlecase equivalent [char; 3]array:

use unicode_titlecase::to_titlecase;

assert_eq!(to_titlecase('A'), ['A', '\0', '\0']);
assert_eq!(to_titlecase('Ǆ'), ['ǅ', '\0', '\0']);
assert_eq!(to_titlecase('ﬄ'), ['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:

use unicode_titlecase::TitleCase;
assert_eq!('i'.to_titlecase().to_string(), "I");
assert_eq!('A'.to_titlecase().to_string(), "A");
assert_eq!('Ǆ'.to_titlecase().to_string(), "ǅ");
assert_eq!('ﬄ'.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:

use unicode_titlecase::to_titlecase_tr_or_az;
assert_eq!(to_titlecase_tr_or_az('i'), ['İ', '\0', '\0']);

And as an iterator:

use unicode_titlecase::TitleCase;
assert_eq!('i'.to_titlecase_tr_or_az().to_string(), "İ");

License