Unicode Case Mapping

https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/
Admin
This project maps a character to its lowercase, uppercase, or titlecase equivalent.
Tokens:3,954
Snippets:54
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### to_uppercase(c: char) -> [u32; 3]

Source: https://docs.rs/unicode-case-mapping

Maps the supplied character to its uppercase equivalent.

```APIDOC
## to_uppercase(c: char) -> [u32; 3]

### Description
Maps the supplied character to its uppercase equivalent.

### Parameters
- **c** (char) - The character to convert to uppercase.
```

--------------------------------

### Perform Unicode Case Mapping

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/index.html?search=std%3A%3Avec

Demonstrates the usage of to_lowercase, to_uppercase, to_titlecase, and case_folded functions for character transformations.

```rust
use std::num::NonZeroU32;

// U+0307 is COMBINING DOT ABOVE
assert_eq!(unicode_case_mapping::to_lowercase('İ'), ['i' as u32, 0x0307]);
assert_eq!(unicode_case_mapping::to_lowercase('ß'), [0; 2]);
assert_eq!(unicode_case_mapping::to_uppercase('ß'), ['S' as u32, 'S' as u32, 0]);
assert_eq!(unicode_case_mapping::to_titlecase('ß'), ['S' as u32, 's' as u32, 0]);
assert_eq!(unicode_case_mapping::to_titlecase('-'), [0; 3]);
assert_eq!(unicode_case_mapping::case_folded('I'), NonZeroU32::new('i' as u32));
assert_eq!(unicode_case_mapping::case_folded('ß'), None);
assert_eq!(unicode_case_mapping::case_folded('ẞ'), NonZeroU32::new('ß' as u32));
```

--------------------------------

### to_lowercase(c: char) -> [u32; 2]

Source: https://docs.rs/unicode-case-mapping

Maps the supplied character to its lowercase equivalent.

```APIDOC
## to_lowercase(c: char) -> [u32; 2]

### Description
Maps the supplied character to its lowercase equivalent.

### Parameters
- **c** (char) - The character to convert to lowercase.
```

--------------------------------

### Access UNICODE_VERSION constant

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/constant.UNICODE_VERSION.html?search=

Represents the Unicode version as a tuple of three u64 integers.

```rust
pub const UNICODE_VERSION: (u64, u64, u64);
```

--------------------------------

### pub fn to_titlecase(chr: char) -> [u32; 3]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_titlecase.html

Maps the supplied character to its titlecase equivalent. The result is returned as an array of three u32 values, where unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.

```APIDOC
## Function: to_titlecase

### Description
Maps the supplied character to its titlecase equivalent. The titlecase equivalent may be more than one code point.

### Signature
`pub fn to_titlecase(chr: char) -> [u32; 3]`

### Parameters
- **chr** (char) - The character to map to titlecase.

### Returns
- **[u32; 3]** - An array containing the titlecase code points. Unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.
```

--------------------------------

### to_uppercase(chr: char) -> [u32; 3]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_uppercase.html

Maps the supplied character to its uppercase equivalent. The result is returned as an array of three u32 values, where unused elements are set to 0. A result of all zeros indicates the character maps to itself.

```APIDOC
## Function: to_uppercase

### Description
Maps the supplied character to its uppercase equivalent. The uppercase equivalent may be more than one code point.

### Signature
`pub fn to_uppercase(chr: char) -> [u32; 3]`

### Parameters
- **chr** (char) - The character to convert to uppercase.

### Returns
- **[u32; 3]** - An array containing the uppercase code points. Unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.
```

--------------------------------

### pub fn to_lowercase(chr: char) -> [u32; 2]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_lowercase.html?search=

Maps the supplied character to its lowercase equivalent. The result is returned as an array of two u32 values, where unused elements are set to 0. A result of all zeros indicates the character maps to itself.

```APIDOC
## Function: to_lowercase

### Description
Maps the supplied character to its lowercase equivalent. The lowercase equivalent may be more than one code point.

### Signature
`pub fn to_lowercase(chr: char) -> [u32; 2]`

### Parameters
- **chr** (char) - The character to convert to lowercase.

### Returns
- **[u32; 2]** - An array containing the lowercase equivalent code points. Unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.
```

--------------------------------

### to_lowercase(chr: char) -> [u32; 2]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_lowercase.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Maps the supplied character to its lowercase equivalent. The result is returned as an array of two u32 values, where unused elements are set to 0. A result of all zeros indicates the character maps to itself.

```APIDOC
## Function: to_lowercase

### Description
Maps the supplied character to its lowercase equivalent. The lowercase equivalent may be more than one code point.

### Signature
`pub fn to_lowercase(chr: char) -> [u32; 2]`

### Parameters
- **chr** (char) - The character to convert to lowercase.

### Returns
- **[u32; 2]** - An array containing the lowercase equivalent code points. Unused elements are set to 0. A result of all zeros indicates the character maps to itself.
```

--------------------------------

### to_titlecase(chr: char) -> [u32; 3]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_titlecase.html?search=std%3A%3Avec

Maps the supplied character to its titlecase equivalent. The result is returned as an array of three u32 values, where unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.

```APIDOC
## fn to_titlecase

### Description
Maps the supplied character to its titlecase equivalent. The titlecase equivalent may be more than one code point.

### Signature
`pub fn to_titlecase(chr: char) -> [u32; 3]`

### Parameters
- **chr** (char) - The character to map to titlecase.

### Returns
- **[u32; 3]** - An array containing the titlecase equivalent code points. Unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.
```

--------------------------------

### to_titlecase function signature

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_titlecase.html

The function signature for mapping a character to its titlecase equivalent.

```rust
pub fn to_titlecase(chr: char) -> [u32; 3]
```

--------------------------------

### to_titlecase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/all.html

Returns the Unicode titlecase form of a character.

```APIDOC
## to_titlecase

### Description
Returns the Unicode titlecase form of a character.

### Signature
`pub fn to_titlecase(c: char) -> impl Iterator<Item = char>`
```

--------------------------------

### to_uppercase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/all.html

Returns the Unicode uppercase form of a character.

```APIDOC
## to_uppercase

### Description
Returns the Unicode uppercase form of a character.

### Signature
`pub fn to_uppercase(c: char) -> impl Iterator<Item = char>`
```

--------------------------------

### to_titlecase(chr: char) -> [u32; 3]

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_titlecase.html?search=

Maps the supplied character to its titlecase equivalent. The result is returned as an array of three u32 values, where unused elements are set to 0. A result of all zeros indicates the character maps to itself.

```APIDOC
## Function: to_titlecase

### Description
Maps the supplied character to its titlecase equivalent. The titlecase equivalent may be more than one code point.

### Signature
`pub fn to_titlecase(chr: char) -> [u32; 3]`

### Parameters
- **chr** (char) - The character to convert to titlecase.

### Returns
- **[u32; 3]** - An array containing the titlecase code points. Unused elements are set to 0. A result of all zeros indicates the character maps to itself.
```

--------------------------------

### to_lowercase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/all.html

Returns the Unicode lowercase form of a character.

```APIDOC
## to_lowercase

### Description
Returns the Unicode lowercase form of a character.

### Signature
`pub fn to_lowercase(c: char) -> impl Iterator<Item = char>`
```

--------------------------------

### to_uppercase Function Signature

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_uppercase.html

The function signature for mapping a character to its uppercase equivalent.

```rust
pub fn to_uppercase(chr: char) -> [u32; 3]
```

--------------------------------

### pub fn case_folded(chr: char) -> Option<NonZeroU32>

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.case_folded.html?search=u32+-%3E+bool

Maps the supplied character to its case-folded equivalent.

```APIDOC
## Function: case_folded

### Description
Maps the supplied character to its case-folded equivalent.

### Signature
`pub fn case_folded(chr: char) -> Option<NonZeroU32>`

### Parameters
- **chr** (char) - The character to be case-folded.

### Returns
- **Option<NonZeroU32>** - The case-folded equivalent of the character, if available.
```

--------------------------------

### to_titlecase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_titlecase.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Maps the supplied character to its titlecase equivalent. The result is returned as an array of three u32 values, where unused elements are set to 0. A result of all zeros indicates the character maps to itself.

```APIDOC
## Function: to_titlecase

### Description
Maps the supplied character to its titlecase equivalent. The titlecase equivalent may be more than one code point.

### Signature
`pub fn to_titlecase(chr: char) -> [u32; 3]`

### Parameters
- **chr** (char) - The character to convert to titlecase.

### Returns
- **[u32; 3]** - An array containing the titlecase mapping. Unused elements are set to 0. A result of all zeros indicates the codepoint maps to itself.
```

--------------------------------

### unicode_case_mapping::to_uppercase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/index.html?search=std%3A%3Avec

Maps the supplied character to its uppercase equivalent.

```APIDOC
## fn to_uppercase(c: char) -> [u32; N]

### Description
Maps the supplied character to its uppercase equivalent.

### Parameters
- **c** (char) - The character to convert to uppercase.
```

--------------------------------

### unicode_case_mapping::to_titlecase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/index.html?search=std%3A%3Avec

Maps the supplied character to its titlecase equivalent.

```APIDOC
## fn to_titlecase(c: char) -> [u32; N]

### Description
Maps the supplied character to its titlecase equivalent.

### Parameters
- **c** (char) - The character to convert to titlecase.
```

--------------------------------

### unicode_case_mapping::to_lowercase

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/index.html?search=std%3A%3Avec

Maps the supplied character to its lowercase equivalent.

```APIDOC
## fn to_lowercase(c: char) -> [u32; N]

### Description
Maps the supplied character to its lowercase equivalent.

### Parameters
- **c** (char) - The character to convert to lowercase.
```

--------------------------------

### fn case_folded

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.case_folded.html?search=std%3A%3Avec

Maps the supplied character to its case-folded equivalent.

```APIDOC
## Function: case_folded

### Description
Maps the supplied character to its case-folded equivalent.

### Signature
`pub fn case_folded(chr: char) -> Option<NonZeroU32>`

### Parameters
- **chr** (char) - The character to be case-folded.

### Returns
- **Option<NonZeroU32>** - Returns the case-folded equivalent as a NonZeroU32 if one exists, otherwise returns None.
```

--------------------------------

### UNICODE_VERSION

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/constant.UNICODE_VERSION.html?search=u32+-%3E+bool

The UNICODE_VERSION constant represents the Unicode version as a tuple of three u64 integers.

```APIDOC
## UNICODE_VERSION

### Description
The version of Unicode that this version of unicode-case-mapping was generated from.

### Signature
`pub const UNICODE_VERSION: (u64, u64, u64);`
```

--------------------------------

### Function signature for case_folded

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.case_folded.html?search=u32+-%3E+bool

The function signature for mapping a character to its case-folded equivalent.

```rust
pub fn case_folded(chr: char) -> Option<NonZeroU32>
```

--------------------------------

### to_lowercase function signature

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/fn.to_lowercase.html?search=

The function returns an array of two u32 values representing the lowercase mapping. Unused elements are set to 0, and a result of all zeros indicates the character maps to itself.

```rust
pub fn to_lowercase(chr: char) -> [u32; 2]
```

--------------------------------

### case_folded

Source: https://docs.rs/unicode-case-mapping/1.0.0/unicode_case_mapping/all.html

Returns the Unicode case-folded form of a character.

```APIDOC
## case_folded

### Description
Returns the Unicode case-folded form of a character.

### Signature
`pub fn case_folded(c: char) -> impl Iterator<Item = char>`
```
Tokens:
Raw