engish 0.3.9

A language utility for sampling and building words.
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

#![warn(missing_docs)]

//! Engish is a library that provides a silly interface for sampling letters and words in an English style.
//! Letter sampling is weighted according to the english language, and support for bigraphs is provided.

/// Various utility functions for general use.
pub mod util;
/// Support for word generation.
#[cfg(feature = "builders")]
pub mod builders;

/// A collection of tools for building a cutsom language model.
pub mod language;

/// The five major vowels in English.
pub const VOWLES: [char; 5] = ['a', 'e', 'i', 'o', 'u'];

/// A collection of the most useful features.
pub mod prelude {
    pub use crate::language::{DictionarySampling, Dictionary, DictionaryStack, Language, Noun,  Verb, Adjective, Word, WordLength};
    pub use crate::util::add_article;
    #[cfg(feature = "builders")]
    pub use crate::builders::{WordBuilder, PropperNounBuilder};
}