Struct bitcoin::util::bip32::DerivationPath

pub struct DerivationPath(_);

A BIP-32 derivation path.

Methods

impl DerivationPath

pub fn len(&self) -> usize

Returns length of the derivation path

pub fn master() -> DerivationPath

Returns derivation path for a master key (i.e. empty derivation path)

pub fn is_master(&self) -> bool

Returns whether derivation path represents master key (i.e. it's length is empty). True for m path.

pub fn child(&self, cn: ChildNumber) -> DerivationPath

Create a new [DerivationPath] that is a child of this one.

pub fn into_child(self, cn: ChildNumber) -> DerivationPath

Convert into a [DerivationPath] that is a child of this one.

Important traits for DerivationPathIterator<'a>

impl<'a> Iterator for DerivationPathIterator<'a> type Item = DerivationPath;

pub fn children_from(&self, cn: ChildNumber) -> DerivationPathIterator

Get an [Iterator] over the children of this [DerivationPath] starting with the given [ChildNumber].

Important traits for DerivationPathIterator<'a>

impl<'a> Iterator for DerivationPathIterator<'a> type Item = DerivationPath;

pub fn normal_children(&self) -> DerivationPathIterator

Get an [Iterator] over the unhardened children of this [DerivationPath].

Important traits for DerivationPathIterator<'a>

impl<'a> Iterator for DerivationPathIterator<'a> type Item = DerivationPath;

pub fn hardened_children(&self) -> DerivationPathIterator

Get an [Iterator] over the hardened children of this [DerivationPath].

pub fn extend<T: AsRef<[ChildNumber]>>(&self, path: T) -> DerivationPath

Concatenate self with path and return the resulting new path.

use bitcoin::util::bip32::{DerivationPath, ChildNumber};
use std::str::FromStr;

let base = DerivationPath::from_str("m/42").unwrap();

let deriv_1 = base.extend(DerivationPath::from_str("m/0/1").unwrap());
let deriv_2 = base.extend(&[
    ChildNumber::from_normal_idx(0).unwrap(),
    ChildNumber::from_normal_idx(1).unwrap()
]);

assert_eq!(deriv_1, deriv_2);

Trait Implementations

impl From<Vec<ChildNumber>> for DerivationPath

fn from(numbers: Vec<ChildNumber>) -> Self

Performs the conversion.

impl<'a> From<&'a [ChildNumber]> for DerivationPath

fn from(numbers: &'a [ChildNumber]) -> Self

Performs the conversion.

impl AsRef<[ChildNumber]> for DerivationPath

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

Performs the conversion.

impl Ord for DerivationPath

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<DerivationPath> for DerivationPath

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

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

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

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

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

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

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

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

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

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

impl Default for DerivationPath

fn default() -> DerivationPath

Returns the "default value" for a type.

impl<'a> IntoIterator for &'a DerivationPath

type Item = &'a ChildNumber

The type of the elements being iterated over.

type IntoIter = Iter<'a, ChildNumber>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Into<Vec<ChildNumber>> for DerivationPath

fn into(self) -> Vec<ChildNumber>

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 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 Eq for DerivationPath

impl Display for DerivationPath

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

Formats the value using the given formatter.

impl Debug for DerivationPath

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

Formats the value using the given formatter.

impl Index<usize> for DerivationPath

type Output = ChildNumber

The returned type after indexing.

fn index(&self, index: usize) -> &ChildNumber

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for DerivationPath

type Output = [ChildNumber]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[ChildNumber]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for DerivationPath

type Output = [ChildNumber]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[ChildNumber]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for DerivationPath

type Output = [ChildNumber]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[ChildNumber]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for DerivationPath

type Output = [ChildNumber]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[ChildNumber]

Performs the indexing (container[index]) operation.

impl Hash for DerivationPath

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl FromIterator<ChildNumber> for DerivationPath

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = ChildNumber>, 

Creates a value from an iterator.

impl FromStr for DerivationPath

type Err = Error

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<DerivationPath, Error>

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