Struct derivation_path::DerivationPath

pub struct DerivationPath(_);

A list of ChildIndex items

Implementations

impl DerivationPath

pub fn new<P>(path: P) -> Self where
    P: Into<Box<[ChildIndex]>>, 

Build a DerivationPath from a list of ChildIndex items

pub fn bip32<P>(path: P) -> Result<Self, DerivationPathError> where
    P: Into<Box<[ChildIndex]>>, 

Build a BIP32 style DerivationPath. This will fail if the length of the path is greater than 255 items

pub fn bip44(
    coin: u32,
    account: u32,
    change: u32,
    address: u32
) -> Result<Self, DerivationPathError>

Build a BIP44 style DerivationPath: m/44'/coin'/account'/change/address

pub fn bip49(
    coin: u32,
    account: u32,
    change: u32,
    address: u32
) -> Result<Self, DerivationPathError>

Build a BIP49 style DerivationPath: m/49'/coin'/account'/change/address

pub fn path(&self) -> &[ChildIndex]

Get a reference to the list of ChildIndex items

pub fn path_type(&self) -> DerivationPathType

Get the DerivationPathType. This will check the "purpose" index in BIP44/49 style derivation paths or otherwise return BIP32 if the length is less than 255

Trait Implementations

impl AsRef<[ChildIndex]> for DerivationPath

fn as_ref(&self) -> &[ChildIndex]

Performs the conversion.

impl Clone for DerivationPath

fn clone(&self) -> DerivationPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DerivationPath

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

Formats the value using the given formatter.

impl Display for DerivationPath

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

Formats the value using the given formatter.

impl Eq for DerivationPath

impl FromStr for DerivationPath

type Err = DerivationPathParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<'a> IntoIterator for &'a DerivationPath

type IntoIter = Iter<'a, ChildIndex>

Which kind of iterator are we turning this into?

type Item = &'a ChildIndex

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<DerivationPath> for DerivationPath

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

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

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

This method tests for !=.

impl StructuralEq for DerivationPath

impl StructuralPartialEq for DerivationPath