engish/
lib.rs

1#![warn(missing_docs)]
2
3//! Engish is a library that provides a silly interface for sampling letters and words in an English style.
4//! Letter sampling is weighted according to the english language, and support for bigraphs is provided.
5
6/// Various utility functions for general use.
7pub mod util;
8/// Support for word generation.
9#[cfg(feature = "builders")]
10pub mod builders;
11
12/// A collection of tools for building a cutsom language model.
13pub mod language;
14
15/// The five major vowels in English.
16pub const VOWLES: [char; 5] = ['a', 'e', 'i', 'o', 'u'];
17
18/// A collection of the most useful features.
19pub mod prelude {
20    pub use crate::language::{DictionarySampling, Dictionary, DictionaryStack, Language, Noun,  Verb, Adjective, Word, WordLength};
21    pub use crate::util::add_article;
22    #[cfg(feature = "builders")]
23    pub use crate::builders::{WordBuilder, PropperNounBuilder};
24}