Struct Lexicon 

pub struct Lexicon { /* private fields */ }

Small, controlled, SFW lexicon by POS. IMPORTANT: ensure cover lexicon does NOT contain any payload (BIP39) words, so decoding (filtering BIP39 words) is trivial and unambiguous.

Implementations

impl Lexicon

pub fn new(payload_set: HashSet<String>, wordlist_set: HashSet<String>) -> Self

pub fn with_semantics(self, model: Arc<SemanticModel>) -> Self

Attach a semantic model for coherence-biased sentence planning.

pub fn semantics(&self) -> Option<&SemanticModel>

The attached semantic model, if any.

pub fn with_words(self, pos: Pos, words: &[&str]) -> Self

pub fn with_refined_cover( self, refined_cover: HashMap<(Pos, String), Vec<String>>, ) -> Self

Set the refined cover word map (populated from cover.yaml refinement tags).

pub fn with_refined_payload( self, refined_payload: HashMap<String, HashSet<String>>, ) -> Self

Set the refined payload word map for type-level validation.

pub fn payload_valid_for_refinement( &self, word: &str, refinement: Option<&str>, ) -> bool

Check if a payload word is valid for a given refinement tag. Returns true if:

• No refinement tag is specified (no constraint)
• No refined_payload entry exists for the tag (no constraint data available)
• The word is in the refined_payload set for the tag

pub fn pick_cover<R: Rng>( &self, rng: &mut R, pos: Pos, recent_words: &[&str], ) -> String

pub fn pick_cover_filtered<R: Rng, F: Fn(&str) -> bool>( &self, rng: &mut R, pos: Pos, recent_words: &[&str], predicate: F, ) -> Option<String>

Like pick_cover, but allows an additional predicate to enforce lightweight grammar constraints (e.g., “bare verb after Modal”, “transitive verb before NP”).

Returns None if no word satisfies the predicate (caller should fall back to pick_cover).

pub fn pick_cover_with_prime_constraint<R: Rng>( &self, rng: &mut R, pos: Pos, recent_words: &[&str], left_word: Option<&str>, right_word: Option<&str>, ) -> Option<String>

Pick cover word with prime ordering constraint for math/primes language. Cover word must be: left_prime < cover_word < right_prime Cover word must be a non-prime integer.

pub fn pick_cover_refined<R: Rng>( &self, rng: &mut R, pos: Pos, refinement: Option<&str>, recent_words: &[&str], ) -> String

Pick a cover word matching both POS and refinement tag. Falls back to unrefined pick_cover if no refinement specified or no matches found.

Trait Implementations

impl Clone for Lexicon

fn clone(&self) -> Lexicon

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Lexicon

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.