Struct DialectConfig 

pub struct DialectConfig {
    pub grammar: Grammar,
    /* private fields */
}

Bundles a grammar with its dialect-specified wordlist references.

Each dialect in grammar.yaml may declare payload_wordlist and cover_wordlist to bind a specific payload/cover pair. If omitted, both default to "default".

The CLI --wordlist flag overrides payload_wordlist (and its implied cover).

Examples

use glossia::grammar::DialectConfig;

// Load the Latin spells dialect — automatically resolves payload_hp.yaml + cover.yaml
let config = DialectConfig::from_language_dialect("latin", "spells").unwrap();
assert_eq!(config.payload_wordlist(), "hp");
assert_eq!(config.cover_wordlist(), "default");

Fields

grammar: Grammar

The grammar (CFG rules + type system) for this dialect.

Implementations

impl DialectConfig

pub fn from_language_dialect( language: &str, dialect: &str, ) -> Result<Self, Box<dyn Error>>

Load a dialect configuration from grammar.yaml.

Reads the dialects.<dialect>.payload_wordlist and dialects.<dialect>.cover_wordlist fields. Falls back to "default" when fields are absent (backward compatible).

If the dialect defines a scale: section (intervals + root), the payload wordlist is derived at runtime from the base chromatic payload filtered by the scale pattern. The derived words are injected into the in-memory cache so that subsequent load_payload_words_for_wordlist() calls find them transparently.

pub fn language(&self) -> &str

Language name.

pub fn dialect(&self) -> &str

Dialect name.

pub fn payload_wordlist(&self) -> &str

Payload wordlist profile name (e.g., “default”, “hp”, “bip39”).

pub fn scale(&self) -> Option<&ScaleDefinition>

Scale definition, if this dialect derives its payload from interval patterns.

pub fn cover_wordlist(&self) -> &str

Cover wordlist profile name (e.g., “default”).

pub fn payload_language(&self) -> &str

The language used to resolve payload wordlist files. Returns payload_language if set, otherwise falls back to self.language.

pub fn n_refinement_tag(&self) -> Option<String>

Get the refinement tag for N (payload note) slots, if any.

Returns the auto-derived or explicit type_refinements tag for the N POS. This is used to populate Lexicon::refined_payload for runtime validation.

pub fn with_payload_wordlist(self, wordlist: &str) -> Self

Override the payload wordlist (e.g., from CLI --wordlist flag). This also updates the cover wordlist to the corresponding named variant if one exists, otherwise leaves cover unchanged.

pub fn with_cover_wordlist(self, wordlist: &str) -> Self

Override the cover wordlist explicitly.

pub fn wordlist_filenames(&self) -> (String, String)

Resolve payload and cover filenames for this dialect. Returns (payload_filename, cover_filename) — e.g., ("payload_hp.yaml", "cover.yaml"). Uses payload_language (if set) to resolve payload files from a different language.

pub fn available_dialects(language: &str) -> Vec<String>

List all dialect names defined in a language’s grammar.yaml.

Returns the base dialect “body” plus all names under the dialects: key.

Trait Implementations

impl Clone for DialectConfig

fn clone(&self) -> DialectConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DialectConfig

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

Formats the value using the given formatter.