Struct bip39::Mnemonic [−][src]
A mnemonic code.
The core::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
[src]
pub fn from_entropy_in(
language: Language,
entropy: &[u8]
) -> Result<Mnemonic, Error>
[src]
language: Language,
entropy: &[u8]
) -> Result<Mnemonic, Error>
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, Error>
[src]
Create a new English Mnemonic from the given entropy. Entropy must be a multiple of 32 bits (4 bytes) and 128-256 bits in length.
pub fn generate_in_with<R>(
rng: &mut R,
language: Language,
word_count: usize
) -> Result<Mnemonic, Error> where
R: RngCore + CryptoRng,
[src]
rng: &mut R,
language: Language,
word_count: usize
) -> Result<Mnemonic, Error> where
R: RngCore + CryptoRng,
Generate a new Mnemonic in the given language with the given randomness source. For the different supported word counts, see documentation on Mnemonic.
Example:
extern crate rand; extern crate bip39; use bip39::{Mnemonic, Language}; let mut rng = rand::thread_rng(); let m = Mnemonic::generate_in_with(&mut rng, Language::English, 24).unwrap();
pub fn language(&self) -> Language
[src]
Get the language of the Mnemonic.
pub fn word_iter(&self) -> impl Iterator<Item = &'static str> + Clone + '_
[src]
Get an iterator over the words.
pub fn language_of<S: AsRef<str>>(mnemonic: S) -> Result<Language, Error>
[src]
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::AmbiguousLanguages is returned, containing the possible languages.
pub fn parse_in_normalized(
language: Language,
s: &str
) -> Result<Mnemonic, Error>
[src]
language: Language,
s: &str
) -> Result<Mnemonic, Error>
Parse a mnemonic in normalized UTF8 in the given language.
pub fn parse_normalized(s: &str) -> Result<Mnemonic, Error>
[src]
Parse a mnemonic in normalized UTF8.
pub fn parse_in<'a, S: Into<Cow<'a, str>>>(
language: Language,
s: S
) -> Result<Mnemonic, Error>
[src]
language: Language,
s: S
) -> Result<Mnemonic, Error>
Parse a mnemonic in the given language.
pub fn parse<'a, S: Into<Cow<'a, str>>>(s: S) -> Result<Mnemonic, Error>
[src]
Parse a mnemonic and detect the language from the enabled languages.
pub fn word_count(&self) -> usize
[src]
Get the number of words in the mnemonic.
pub fn to_seed_normalized(&self, normalized_passphrase: &str) -> [u8; 64]
[src]
Convert to seed bytes with a passphrase in normalized UTF8.
pub fn to_seed<'a, P: Into<Cow<'a, str>>>(&self, passphrase: P) -> [u8; 64]
[src]
Convert to seed bytes.
pub fn to_entropy_array(&self) -> ([u8; 33], usize)
[src]
Convert the mnemonic back to the entropy used to generate it.
The return value is a byte array and the size.
Use Mnemonic::to_entropy (needs std
) to get a Vec
pub fn to_entropy(&self) -> Vec<u8>
[src]
Convert the mnemonic back to the entropy used to generate it.
Trait Implementations
impl Clone for Mnemonic
[src]
impl Debug for Mnemonic
[src]
impl<'de> Deserialize<'de> for Mnemonic
[src]
fn deserialize<D>(deserializer: D) -> Result<Mnemonic, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
impl Display for Mnemonic
[src]
impl Eq for Mnemonic
[src]
impl FromStr for Mnemonic
[src]
type Err = Error
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Mnemonic, Error>
[src]
impl Hash for Mnemonic
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Mnemonic
[src]
fn cmp(&self, other: &Mnemonic) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Mnemonic> for Mnemonic
[src]
impl PartialOrd<Mnemonic> for Mnemonic
[src]
fn partial_cmp(&self, other: &Mnemonic) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'de> Serialize for Mnemonic
[src]
impl StructuralEq for Mnemonic
[src]
impl StructuralPartialEq for Mnemonic
[src]
Auto Trait Implementations
impl RefUnwindSafe for Mnemonic
impl Send for Mnemonic
impl Sync for Mnemonic
impl Unpin for Mnemonic
impl UnwindSafe for Mnemonic
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,