Enum MnemonicLanguage

pub enum MnemonicLanguage {
    English = 0,
    SimplifiedChinese = 1,
    TraditionalChinese = 2,
    Czech = 3,
    French = 4,
    Italian = 5,
    Japanese = 6,
    Korean = 7,
    Portuguese = 8,
    Spanish = 9,
}

The language used for BIP-39/BIP-44 mnemonic seed phrases in a wallet.

MnemonicLanguage represents the human language in which a wallet’s recovery seed phrase is expressed. Zcash wallets, like many cryptocurrency wallets, use mnemonic phrases (typically 12, 18, or 24 words) as a human-readable backup for the wallet’s seed material.

Zcash Concept Relation

Zcash wallets commonly use BIP-39 mnemonics as the basis for hierarchical deterministic (HD) wallet generation. The language of the mnemonic matters because:

• Each language has its own standardized wordlist with 2048 specific words
• Words must be from the same language to be valid for a given mnemonic
• The language determines which wordlist is used for validation and generation

Zcash wallets typically follow the same standards as Bitcoin for mnemonic implementation, supporting multiple languages for wider accessibility.

Data Preservation

During wallet migration, preserving the mnemonic language is important for:

• Correctly interpreting any stored mnemonic phrases
• Maintaining consistent wallet recovery procedures
• Ensuring users can recover funds using their preferred language

Examples

// Create a language identifier from a numeric value
let language = MnemonicLanguage::from_u32(0)?;
assert_eq!(language, MnemonicLanguage::English);

// Get the language name
assert_eq!(language.name(), "English");

// Languages can be displayed as strings
println!("Mnemonic language: {}", language); // Outputs "Mnemonic language: English"

Variants

English = 0

English wordlist (the most commonly used)

SimplifiedChinese = 1

Simplified Chinese wordlist

TraditionalChinese = 2

Traditional Chinese wordlist

Czech = 3

Czech wordlist

French = 4

French wordlist

Italian = 5

Italian wordlist

Japanese = 6

Japanese wordlist

Korean = 7

Korean wordlist

Portuguese = 8

Portuguese wordlist

Spanish = 9

Spanish wordlist

Implementations

impl MnemonicLanguage

pub fn from_u32(value: u32) -> Result<Self>

Creates a MnemonicLanguage from a numeric identifier.

This method converts a raw numeric value into the corresponding language enum variant. Zcash wallets typically store the language as a numeric value in their configuration or database.

Arguments

• value - The numeric identifier for the language (0-9)

Returns

A Result containing the MnemonicLanguage if the value is valid, or an error if the value doesn’t correspond to a supported language.

Examples

// Create English (most common) language
let english = MnemonicLanguage::from_u32(0)?;

// Create French language
let french = MnemonicLanguage::from_u32(4)?;

// Invalid value results in error
let result = MnemonicLanguage::from_u32(99);
assert!(result.is_err());

pub fn name(&self) -> &'static str

Returns the string name of the mnemonic language.

This method returns the canonical name of the language as a static string, which is useful for display purposes or when translating between numeric and human-readable representations.

Returns

A static string containing the name of the language.

Examples

let language = MnemonicLanguage::English;
assert_eq!(language.name(), "English");

let language = MnemonicLanguage::Japanese;
assert_eq!(language.name(), "Japanese");

Trait Implementations

impl Clone for MnemonicLanguage

fn clone(&self) -> MnemonicLanguage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MnemonicLanguage

Formats the mnemonic language for debugging output

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

Formats the value using the given formatter.

impl Display for MnemonicLanguage

Formats the mnemonic language as a human-readable string

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

Formats the value using the given formatter.

impl From<MnemonicLanguage> for CBOR

fn from(value: MnemonicLanguage) -> Self

Converts to this type from the input type.

impl From<MnemonicLanguage> for Envelope

fn from(value: MnemonicLanguage) -> Self

Converts to this type from the input type.

impl From<MnemonicLanguage> for String

fn from(value: MnemonicLanguage) -> Self

Converts to this type from the input type.

impl PartialEq for MnemonicLanguage

fn eq(&self, other: &MnemonicLanguage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<CBOR> for MnemonicLanguage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl TryFrom<Envelope> for MnemonicLanguage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for MnemonicLanguage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MnemonicLanguage

impl StructuralPartialEq for MnemonicLanguage