random_word 0.5.2

Efficient functions for generating random words in many languages.
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

# random_word

The `random_word` crate provides an efficient way to generate
random words. Included words can be filtered by length or
first character.

## Usage
You **MUST** enable a crate language feature.
Crate language features are mandatory to reduce binary size.
Example for English in Cargo.toml:
```toml
[dependencies]
random_word = { version = "0.5.2", features = ["en"] }
```

**Supported Languages**
* `De` - German. Requires enabling "de" feature.
* `En` - English. Requires enabling "en" feature.
* `Es` - Spanish. Requires enabling "es" feature.
* `Fr` - French. Requires enabling "fr" feature.
* `Ja` - Japanese. Requires enabling "ja" feature.
* `Ru` - Russian. Requires enabling "ru" feature.
* `Zh` - Chinese. Requires enabling "zh" feature.

## Generating a random English word

```rust
use random_word::Lang;

fn main() {
    let word = random_word::get(Lang::En);
}
```

## Generating a random English word starting with 'c'

```rust
use random_word::Lang;

fn main() {
    let word = random_word::get_starts_with('c', Lang::En);
    assert!(word.is_some());
}
```

## Get all 4 length French words

```rust
use random_word::Lang;

fn main() {
    let word_list = random_word::all_len(4, Lang::Fr);
    assert!(!word_list.is_empty());
}
```