Struct MnemonicGenerator

pub struct MnemonicGenerator { /* private fields */ }

A generator for creating memorable word combinations from predefined or custom word lists.

Examples

use mnemonic_generator::MnemonicGenerator;

// Use the default generator
let generator = MnemonicGenerator::new();
let mnemonic = generator.generate().expect("Failed to generate mnemonic");
println!("Generated mnemonic: {}", mnemonic);

// Create a generator with custom words
let custom_generator = MnemonicGenerator::with_words(
    vec!["amazing".to_string(), "friendly".to_string(), "epic".to_string()],
    vec!["einstein".to_string(), "galileo".to_string()]
);
let custom_mnemonic = custom_generator.generate_with_separator("-")
    .expect("Failed to generate custom mnemonic");
println!("Custom mnemonic: {}", custom_mnemonic);

Implementations

impl MnemonicGenerator

Creates a new MnemonicGenerator with a default set of words.

Examples

use mnemonic_generator::MnemonicGenerator;

let generator = MnemonicGenerator::new();
let mnemonic = generator.generate().expect("Failed to generate mnemonic");

pub fn new() -> Self

Create a new MnemonicGenerator with default words

pub fn with_words(left_words: Vec<String>, right_words: Vec<String>) -> Self

Creates a MnemonicGenerator with custom word lists.

Arguments

• left_words - A vector of words to be used as the first part of the mnemonic
• right_words - A vector of words to be used as the second part of the mnemonic

Examples

use mnemonic_generator::MnemonicGenerator;

let generator = MnemonicGenerator::with_words(
    vec!["amazing".to_string(), "legend".to_string()],
    vec!["jordan".to_string(), "larry".to_string()]
);
let mnemonic = generator.generate().expect("Failed to generate mnemonic");

pub fn generate(&self) -> Result<String, MnemonicError>

Generates a mnemonic using the default underscore separator.

Errors

Returns MnemonicError::EmptyWordList if no words are available for generation

Examples

use mnemonic_generator::MnemonicGenerator;

let generator = MnemonicGenerator::new();
match generator.generate() {
    Ok(mnemonic) => println!("Generated mnemonic: {}", mnemonic),
    Err(e) => eprintln!("Error generating mnemonic: {}", e)
}

pub fn generate_with_separator( &self, separator: &str, ) -> Result<String, MnemonicError>

Generates a mnemonic using a custom separator.

Arguments

• separator - A string slice to be used between the two words

Errors

Returns MnemonicError::EmptyWordList if no words are available for generation

Examples

use mnemonic_generator::MnemonicGenerator;

let generator = MnemonicGenerator::new();
match generator.generate_with_separator("-") {
    Ok(mnemonic) => println!("Generated mnemonic: {}", mnemonic),
    Err(e) => eprintln!("Error generating mnemonic: {}", e)
}

Trait Implementations

impl Default for MnemonicGenerator

fn default() -> Self

Returns the “default value” for a type.