dale-chall 0.1.1

static word-list data for the Dale-Chall readability formula
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

# dale-chall

The New Dale-Chall (1995) list of easy American-English words, as static Rust
data.

Readability tools use this list to decide whether a word is familiar when
scoring text. This crate ships the data only. It does not compute the Dale-Chall
formula.

The crate is `#![no_std]` and has no dependencies. The minimum supported Rust
version is 1.65.

## Install

```toml
[dependencies]
dale-chall = "0.1"
```

## Use

```rust
use dale_chall::DALE_CHALL;

assert_eq!(DALE_CHALL.len(), 2942);
assert_eq!(DALE_CHALL[0], "a");

assert!(DALE_CHALL.binary_search(&"old-fashioned").is_ok());
assert!(DALE_CHALL.binary_search(&"xylophone").is_err());
```

## Data

`DALE_CHALL` is a `&'static [&'static str]` of 2942 words. The list is sorted
ascending by byte order and holds no duplicates. Every entry is lowercase ASCII.
Nine words contain a hyphen and 47 contain a straight apostrophe (`'`, U+0027).

The slice is sorted, so check membership with
`DALE_CHALL.binary_search(&word).is_ok()`. The check is exact and case
sensitive. The data is already lowercase, so lowercase the query first if the
input may carry other casing.

## License

Licensed under the [MIT license](LICENSE).