Struct bdk_chain::bitcoin::bip32::DerivationPath

pub struct DerivationPath(/* private fields */);
Expand description

A BIP-32 derivation path.

Implementations§

§

impl DerivationPath

pub fn len(&self) -> usize

Returns length of the derivation path

pub fn is_empty(&self) -> bool

Returns true if the derivation path is empty

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.

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

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

pub fn normal_children(&self) -> DerivationPathIterator<'_>

Get an Iterator over the unhardened children of this DerivationPath.

pub fn hardened_children(&self) -> DerivationPathIterator<'_>

Get an Iterator over the hardened children of this DerivationPath.

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

Concatenate self with path and return the resulting new path.

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

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

let deriv_1 = base.extend(DerivationPath::from_str("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);

pub fn to_u32_vec(&self) -> Vec<u32>

Returns the derivation path as a vector of u32 integers. Unhardened elements are copied as is. 0x80000000 is added to the hardened elements.

use bitcoin::bip32::DerivationPath;
use std::str::FromStr;

let path = DerivationPath::from_str("m/84'/0'/0'/0/1").unwrap();
const HARDENED: u32 = 0x80000000;
assert_eq!(path.to_u32_vec(), vec![84 + HARDENED, HARDENED, HARDENED, 0, 1]);

Trait Implementations§

§

impl AsRef<[ChildNumber]> for DerivationPath

§

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

Converts this type into a shared reference of the (usually inferred) input type.
§

impl Clone for DerivationPath

§

fn clone(&self) -> DerivationPath

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
§

impl Debug for DerivationPath

§

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

Formats the value using the given formatter. Read more
§

impl Default for DerivationPath

§

fn default() -> DerivationPath

Returns the “default value” for a type. Read more
§

impl<'de> Deserialize<'de> for DerivationPath

§

fn deserialize<D>( deserializer: D ) -> Result<DerivationPath, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for DerivationPath

§

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

Formats the value using the given formatter. Read more
§

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

§

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

Converts to this type from the input type.
§

impl From<DerivationPath> for Vec<ChildNumber>

§

fn from(path: DerivationPath) -> Vec<ChildNumber>

Converts to this type from the input type.
§

impl From<Vec<ChildNumber>> for DerivationPath

§

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

Converts to this type from the input type.
§

impl FromIterator<ChildNumber> for DerivationPath

§

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

Creates a value from an iterator. Read more
§

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. Read more
§

impl Hash for DerivationPath

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl<I> Index<I> for DerivationPath
where Vec<ChildNumber>: Index<I>,

§

type Output = <Vec<ChildNumber> as Index<I>>::Output

The returned type after indexing.
§

fn index(&self, index: I) -> &<DerivationPath as Index<I>>::Output

Performs the indexing (container[index]) operation. Read more
§

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) -> <&'a DerivationPath as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
§

impl Ord for DerivationPath

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for DerivationPath

§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl PartialOrd for DerivationPath

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for DerivationPath

§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl Eq for DerivationPath

§

impl StructuralPartialEq for DerivationPath

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

§

impl<T> IntoDerivationPath for T
where T: Into<DerivationPath>,

§

fn into_derivation_path(self) -> Result<DerivationPath, Error>

Converts a given type into a DerivationPath with possible error
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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,