Enum bip0039::MnemonicType

pub enum MnemonicType {
    Words12,
    Words15,
    Words18,
    Words21,
    Words24,
}

Determines the number of words that will be present in a Mnemonic phrase

Also directly affects the amount of entropy that will be used to create a Mnemonic, and therefore the cryptographic strength of the HD wallet keys/addresses that can be derived from it using the Seed.

For example, a 12 word mnemonic phrase is essentially a friendly representation of a 128-bit key, while a 24 word mnemonic phrase is essentially a 256-bit key.

If you know you want a specific phrase length, you can use the enum variant directly, for example MnemonicType::Words12.

You can also get a MnemonicType that corresponds to one of the standard BIP39 key sizes by passing arbitrary usize values:

use bip0039::{MnemonicType};

let mnemonic_type = MnemonicType::for_key_size(128).unwrap();

Variants

Words12

Word count is 12.

Words15

Word count is 15.

Words18

Word count is 18.

Words21

Word count is 21.

Words24

Word count is 24.

Methods

impl MnemonicType

pub fn for_word_count(size: usize) -> Result<MnemonicType>

Get a MnemonicType for a mnemonic phrase with a specific number of words

Specifying a word count not provided for by the BIP39 standard will return an Error of kind Error::InvalidWordLength.

Example

use bip0039::{MnemonicType};

let mnemonic_type = MnemonicType::for_word_count(12).unwrap();

pub fn for_key_size(size: usize) -> Result<MnemonicType>

Get a MnemonicType for a mnemonic phrase representing the given key size as bits

Specifying a key size not provided for by the BIP39 standard will return an Error of kind Error::InvalidKeysize.

Example

use bip0039::{MnemonicType};

let mnemonic_type = MnemonicType::for_key_size(128).unwrap();

pub fn for_phrase(phrase: &str) -> Result<MnemonicType>

Get a MnemonicType for an existing mnemonic phrase

This can be used when you need information about a mnemonic phrase based on the number of words, for example you can get the entropy value using MnemonicType::entropy_bits.

Specifying a phrase that does not match one of the standard BIP39 phrase lengths will return an Error of kind Error::InvalidWordLength. The phrase will not be validated in any other way.

Example

use bip0039::{MnemonicType};

let test_mnemonic = "park remain person kitchen mule spell knee armed position rail grid ankle";

let mnemonic_type = MnemonicType::for_phrase(test_mnemonic).unwrap();

let entropy_bits = mnemonic_type.entropy_bits();

pub fn total_bits(self) -> usize

Return the number of entropy+checksum bits

Example

use bip0039::{MnemonicType};

let test_mnemonic = "park remain person kitchen mule spell knee armed position rail grid ankle";

let mnemonic_type = MnemonicType::for_phrase(test_mnemonic).unwrap();

let total_bits = mnemonic_type.total_bits();

pub fn entropy_bits(self) -> usize

Return the number of entropy bits

Example

use bip0039::{MnemonicType};

let test_mnemonic = "park remain person kitchen mule spell knee armed position rail grid ankle";

let mnemonic_type = MnemonicType::for_phrase(test_mnemonic).unwrap();

let entropy_bits = mnemonic_type.entropy_bits();

pub fn checksum_bits(self) -> u8

Return the number of checksum bits

Example

use bip0039::{MnemonicType};

let test_mnemonic = "park remain person kitchen mule spell knee armed position rail grid ankle";

let mnemonic_type = MnemonicType::for_phrase(test_mnemonic).unwrap();

let checksum_bits = mnemonic_type.checksum_bits();

pub fn word_count(self) -> usize

Return the number of words

Example

use bip0039::{MnemonicType};

let mnemonic_type = MnemonicType::Words12;

let word_count = mnemonic_type.word_count();

Trait Implementations

impl Clone for MnemonicType

fn clone(&self) -> MnemonicType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MnemonicType

impl Debug for MnemonicType

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

Formats the value using the given formatter.

impl Default for MnemonicType

fn default() -> MnemonicType

Returns the "default value" for a type.

impl Display for MnemonicType

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

Formats the value using the given formatter.