Struct coins_bip39::mnemonic::Mnemonic

source · [−]

pub struct Mnemonic<W: Wordlist> { /* private fields */ }

Expand description

Mnemonic represents entropy that can be represented as a phrase. A mnemonic can be used to deterministically generate an extended private key or derive its child keys.

Implementations

source

impl<W: Wordlist> Mnemonic<W>

source

pub fn new<R: Rng>(rng: &mut R) -> Self

Returns a new mnemonic generated using the provided random number generator.

source

pub fn new_with_count<R: Rng>(
rng: &mut R,
count: usize
) -> Result<Self, MnemonicError>

Returns a new mnemonic given the word count, generated using the provided random number generator.

source

pub fn new_from_phrase(phrase: &str) -> Result<Self, MnemonicError>

Returns a new mnemonic for a given phrase. The 12-24 space-separated words are used to calculate the entropy that must have produced it.

source

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

Converts the mnemonic into phrase.

source

impl<W: Wordlist> Mnemonic<W>

source

pub fn master_key(&self, password: Option<&str>) -> Result<XPriv, MnemonicError>

Returns the master private key of the corresponding mnemonic.

source

pub fn derive_key<E, P>(
 &self,
 path: P,
 password: Option<&str>
) -> Result<XPriv, MnemonicError> where
 E: Into<Bip32Error>,
 P: TryInto<DerivationPath, Error = E>,

Returns the derived child private key of the corresponding mnemonic at the given index.

Trait Implementations

source

impl<W: Clone + Wordlist> Clone for Mnemonic<W>

source

fn clone(&self) -> Mnemonic<W>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<W: Debug + Wordlist> Debug for Mnemonic<W>

source

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

Formats the value using the given formatter. Read more

source

impl<W: PartialEq + Wordlist> PartialEq<Mnemonic<W>> for Mnemonic<W>

source

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

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

source

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

This method tests for !=.

source

impl<W: Eq + Wordlist> Eq for Mnemonic<W>

source

impl<W: Wordlist> StructuralEq for Mnemonic<W>

source

impl<W: Wordlist> StructuralPartialEq for Mnemonic<W>

Auto Trait Implementations

impl<W> RefUnwindSafe for Mnemonic<W> where
W: RefUnwindSafe,

impl<W> Send for Mnemonic<W> where
W: Send,

impl<W> Sync for Mnemonic<W> where
W: Sync,

impl<W> Unpin for Mnemonic<W> where
W: Unpin,

impl<W> UnwindSafe for Mnemonic<W> where
W: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct coins_bip39::mnemonic::Mnemonic

Implementations

impl<W: Wordlist> Mnemonic<W>

pub fn new<R: Rng>(rng: &mut R) -> Self

pub fn new_with_count<R: Rng>( rng: &mut R, count: usize) -> Result<Self, MnemonicError>

pub fn new_from_phrase(phrase: &str) -> Result<Self, MnemonicError>

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

impl<W: Wordlist> Mnemonic<W>

pub fn master_key(&self, password: Option<&str>) -> Result<XPriv, MnemonicError>

pub fn derive_key<E, P>( &self, path: P, password: Option<&str>) -> Result<XPriv, MnemonicError> where E: Into<Bip32Error>, P: TryInto<DerivationPath, Error = E>,

Trait Implementations

impl<W: Clone + Wordlist> Clone for Mnemonic<W>

fn clone(&self) -> Mnemonic<W>

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

impl<W: Debug + Wordlist> Debug for Mnemonic<W>

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

impl<W: PartialEq + Wordlist> PartialEq<Mnemonic<W>> for Mnemonic<W>

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

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

impl<W: Eq + Wordlist> Eq for Mnemonic<W>

impl<W: Wordlist> StructuralEq for Mnemonic<W>

impl<W: Wordlist> StructuralPartialEq for Mnemonic<W>

Auto Trait Implementations

impl<W> RefUnwindSafe for Mnemonic<W> where W: RefUnwindSafe,

impl<W> Send for Mnemonic<W> where W: Send,

impl<W> Sync for Mnemonic<W> where W: Sync,

impl<W> Unpin for Mnemonic<W> where W: Unpin,

impl<W> UnwindSafe for Mnemonic<W> where W: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn new_with_count<R: Rng>(
rng: &mut R,
count: usize
) -> Result<Self, MnemonicError>

pub fn derive_key<E, P>(
&self,
path: P,
password: Option<&str>
) -> Result<XPriv, MnemonicError> where
E: Into<Bip32Error>,
P: TryInto<DerivationPath, Error = E>,

impl<W> RefUnwindSafe for Mnemonic<W> where
W: RefUnwindSafe,

impl<W> Send for Mnemonic<W> where
W: Send,

impl<W> Sync for Mnemonic<W> where
W: Sync,

impl<W> Unpin for Mnemonic<W> where
W: Unpin,

impl<W> UnwindSafe for Mnemonic<W> where
W: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,