Struct deep_space::mnemonic::Mnemonic

pub struct Mnemonic(_);

A mnemonic code.

The std::str::FromStr implementation will try to determine the language of the mnemonic from all the supported languages. (Languages have to be explicitly enabled using the Cargo features.)

Supported number of words are 12, 18 and 24.

Implementations

impl Mnemonic

pub fn from_entropy_in(
    language: Language,
    entropy: &[u8]
) -> Result<Mnemonic, Bip39Error>

Create a new Mnemonic in the specified language from the given entropy. Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length.

pub fn from_entropy(entropy: &[u8]) -> Result<Mnemonic, Bip39Error>

Create a new English Mnemonic in from the given entropy. Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length.

pub fn generate_in(
    language: Language,
    word_count: usize
) -> Result<Mnemonic, Bip39Error>

Generate a new Mnemonic in the given language. For the different supported word counts, see documentation on [Mnemonoc].

pub fn generate(word_count: usize) -> Result<Mnemonic, Bip39Error>

Generate a new Mnemonic in English. For the different supported word counts, see documentation on [Mnemonoc].

pub fn validate_in(language: Language, s: &str) -> Result<(), Bip39Error>

Static method to validate a mnemonic in a given language.

pub fn language_of(s: &str) -> Result<Language, Bip39Error>

Determine the language of the mnemonic.

NOTE: This method only guarantees that the returned language is the correct language on the assumption that the mnemonic is valid. It does not itself validate the mnemonic.

Some word lists don’t guarantee that their words don’t occur in other word lists. In the extremely unlikely case that a word list can be interpreted in multiple languages, an [Error::AmbiguousWordList] is returned, containing the possible languages.

pub fn parse<'a, S: Into<Cow<'a, str>>>(s: S) -> Result<Mnemonic, Bip39Error>

Parse a mnemonic and detect the language from the enabled languages.

pub fn parse_in<'a, S: Into<Cow<'a, str>>>(
    language: Language,
    s: S
) -> Result<Mnemonic, Bip39Error>

Parse a mnemonic in the given language.

pub fn as_str(&self) -> &str

Get the mnemonic as a &str.

pub fn word_count(&self) -> usize

Get the number of words in the mnemonic.

pub fn to_seed(&self, passphrase: &str) -> Vec<u8>

Convert to seed bytes.

pub fn to_entropy(&self) -> Vec<u8>

Convert the mnemonic back to the entropy used to generate it.

Trait Implementations

impl Clone for Mnemonic

fn clone(&self) -> Mnemonic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mnemonic

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

Formats the value using the given formatter.

impl Display for Mnemonic

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

Formats the value using the given formatter.

impl Eq for Mnemonic

impl FromStr for Mnemonic

type Err = Bip39Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Mnemonic, Bip39Error>

Parses a string s to return a value of this type.

impl Hash for Mnemonic

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Mnemonic

fn cmp(&self, other: &Mnemonic) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Mnemonic> for Mnemonic

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Mnemonic> for Mnemonic

fn partial_cmp(&self, other: &Mnemonic) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Mnemonic

impl StructuralPartialEq for Mnemonic