Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmammino/allwords
A Rust crate that allows you to generate words over a given alphabet.
https://github.com/lmammino/allwords
alphabet brute-force bruteforce fuzzy generator iterator random rust words
Last synced: 22 days ago
JSON representation
A Rust crate that allows you to generate words over a given alphabet.
- Host: GitHub
- URL: https://github.com/lmammino/allwords
- Owner: lmammino
- License: mit
- Created: 2021-02-07T12:59:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-18T14:58:10.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T15:42:24.618Z (about 1 month ago)
- Topics: alphabet, brute-force, bruteforce, fuzzy, generator, iterator, random, rust, words
- Language: Rust
- Homepage: https://loige.co
- Size: 20.5 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# allwords 🦀
[](https://github.com/lmammino/allwords/actions?query=workflow%3ARust)
[](https://codecov.io/gh/lmammino/allwords)
[](https://crates.io/crates/allwords)
[](https://docs.rs/allwords)
`allwords` is a Rust crate that allows you to generate words over a given alphabet.
Word generation can be useful in several scenarios:
- Pseudo-random data generation (e.g. testing / mocking)
- Brute forcing of keys / passwords
- Id or Serial number generation
## Install
To install the library add the following lines to your `Cargo.toml`
```toml
[dependencies]
allwords = "0"
```
Or, if you have [`cargo add`](https://github.com/killercup/cargo-edit), you can run the following command:
```bash
cargo add allwords@0
```
## Sample Usage
The basic idea for using this library is that you create an [`Alphabet`](https://docs.rs/allwords/latest/allwords/struct.Alphabet.html) with a set of
characters and then you can use it to generate a [`WordsIterator`](https://docs.rs/allwords/latest/allwords/struct.WordsIterator.html). You can use the iterator
to generate all the possible words over the alphabet.
For instance if you want to generate all the possible words containing `"a"`, `"b"`, `"c"` with
a maximum length of 3 chars:
```rust
use allwords::{Alphabet};
let a = Alphabet::from_chars_in_str("abc").unwrap();
let words: Vec = a.all_words(Some(3)).collect();
let expected_words: Vec = [
"a", "b", "c",
"aa", "ab", "ac", "ba", "bb", "bc", "ca", "cb", "cc",
"aaa", "aab", "aac", "aba", "abb", "abc", "aca", "acb", "acc",
"baa", "bab", "bac", "bba", "bbb", "bbc", "bca", "bcb", "bcc",
"caa", "cab", "cac", "cba", "cbb", "cbc", "cca", "ccb", "ccc"]
.iter()
.map(|s| s.to_string())
.collect();
assert_eq!(words, expected_words);
```
### WordsIterator
Once you create an alphabet `a`, there are 4 different ways to get an iterator:
- [`a.all_words(max_len)`](https://docs.rs/allwords/latest/allwords/struct.Alphabet.html#method.all_words) - Creates an iterator that will generate all the words for a given alphabet. You can optionally specifify a maximum length, after which, the iterator will terminate.
- [`a.all_words_unbound()`](https://docs.rs/allwords/latest/allwords/struct.Alphabet.html#method.all_words_unbound) - A shortcut for creating an unbound (endless) iterator for the given alphabet.
- [`a.all_words_starting_from(start_word, max_len)`](https://docs.rs/allwords/latest/allwords/struct.Alphabet.html#method.all_words_starting_from) - Creates an iterator that will generate all the words for a given alphabet starting from a given word.
- [`a.all_words_with_len(start_len, max_len)`](https://docs.rs/allwords/latest/allwords/struct.Alphabet.html#method.all_words_with_len) - Creates an iterator that will generate all the words for a given alphabet starting from the first word with a given minimum length.
Consult the [crate documentation](https://docs.rs/allwords/latest/) for more details and examples.
## Contributing
Everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/allwords/issues).
## License
Licensed under [MIT License](LICENSE). © Luciano Mammino.