unicode-intervals 0.1.2

Search for Unicode code points intervals by including/excluding categories, ranges, and custom characters sets.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

unicode-intervals
=================

[<img alt="github" src="https://img.shields.io/badge/github-8da0cb?style=flat-square&labelColor=555555&logo=github" height="20">](https://github.com/Stranger6667/unicode-intervals)
[<img alt="crates.io" src="https://img.shields.io/crates/v/unicode-intervals.svg?style=flat-square&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/unicode-intervals)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-unicode_intervals-66c2a5?style=flat-square&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/unicode-intervals)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/Stranger6667/unicode-intervals/ci.yml?branch=main&style=flat-square" height="20">](https://github.com/Stranger6667/unicode-intervals/actions?query=branch%3Amain)

This library provides a way to search for Unicode code point intervals by categories, ranges, and custom character sets.

The main purpose of `unicode-intervals` is to simplify generating strings that matching specific criteria.

```toml
[dependencies]
unicode-intervals = "0.1"
```

<br>

## Examples

The example below will produce code point intervals of uppercase & lowercase letters less than 128 and will include the `☃` character.

```rust
use unicode_intervals::UnicodeCategory;

let intervals = unicode_intervals::query()
    .include_categories(
        UnicodeCategory::UPPERCASE_LETTER | 
        UnicodeCategory::LOWERCASE_LETTER
    )
    .max_codepoint(128)
    .include_characters("☃")
    .intervals()
    .expect("Invalid query input");
assert_eq!(intervals, &[(65, 90), (97, 122), (9731, 9731)]);
```

`IntervalSet` for index-like access to the underlying codepoints:

```rust
let interval_set = unicode_intervals::query()
    .max_codepoint(128)
    .interval_set()
    .expect("Invalid query input");
// Get 10th codepoint in this interval set
assert_eq!(interval_set.codepoint_at(10), Some('K' as u32));
assert_eq!(interval_set.index_of('K'), Some(10));
```

Query specific Unicode version:

```rust
use unicode_intervals::UnicodeVersion;

let intervals = UnicodeVersion::V11_0_0.query()
    .max_codepoint(128)
    .include_characters("☃")
    .intervals()
    .expect("Invalid query input");
assert_eq!(intervals, &[(0, 128), (9731, 9731)]);
```

Restrict the output to code points within a certain range:

```rust
let intervals = unicode_intervals::query()
    .min_codepoint(65)
    .max_codepoint(128)
    .intervals()
    .expect("Invalid query input");
assert_eq!(intervals, &[(65, 128)])
```

Include or exclude specific characters:

```rust
use unicode_intervals::UnicodeCategory;

let intervals = unicode_intervals::query()
    .include_categories(UnicodeCategory::PARAGRAPH_SEPARATOR)
    .include_characters("-123")
    .intervals()
    .expect("Invalid query input");
assert_eq!(intervals, &[(45, 45), (49, 51), (8233, 8233)])
```

## Unicode version support

`unicode-intervals` supports Unicode 9.0.0 - 15.0.0.

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>