Struct RelativeDerivationPath 

pub struct RelativeDerivationPath(/* private fields */);

A relative BIP-0032 derivation path.

Implementations

impl RelativeDerivationPath

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 contains_hardened_child(&self) -> bool

Returns true if the derivation path contains a hardened child number.

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

Constructs a new RelativeDerivationPath that is a child of this one.

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

Converts into a RelativeDerivationPath that is a child of this one.

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

Gets an Iterator over the children of this RelativeDerivationPath starting with the given ChildNumber.

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

Gets an Iterator over the unhardened children of this RelativeDerivationPath.

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

Gets an Iterator over the hardened children of this RelativeDerivationPath.

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

Joins self with path and returns the resulting new path.

use bitcoin_key_expression::bip32::{RelativeDerivationPath, ChildNumber};

let base = "42".parse::<RelativeDerivationPath>().unwrap();

let deriv_1 = base.join("0/1".parse::<RelativeDerivationPath>().unwrap());
let deriv_2 = base.join(&[
    ChildNumber::ZERO_NORMAL,
    ChildNumber::ONE_NORMAL
]);

assert_eq!(deriv_1, deriv_2);

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

Returns the derivation path as a vector of raw BIP-0032 u32 child numbers. Unhardened elements are copied as is. 0x80000000 is added to the hardened elements.

use bitcoin_key_expression::bip32::RelativeDerivationPath;

let path = "84'/0'/0'/0/1".parse::<RelativeDerivationPath>().unwrap();
const HARDENED: u32 = 0x80000000;
assert_eq!(path.to_u32_vec(), vec![84 + HARDENED, HARDENED, HARDENED, 0, 1]);

pub fn from_u32_slice(numbers: &[u32]) -> Self

Constructs a new derivation path from a slice of raw BIP-0032 u32 child numbers.

use bitcoin_key_expression::bip32::RelativeDerivationPath;

const HARDENED: u32 = 0x80000000;
let expected = vec![84 + HARDENED, HARDENED, HARDENED, 0, 1];
let path = RelativeDerivationPath::from_u32_slice(expected.as_slice());
assert_eq!(path.to_u32_vec(), expected);

Trait Implementations

impl<'a> Arbitrary<'a> for RelativeDerivationPath

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<[ChildNumber]> for RelativeDerivationPath

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

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

impl Clone for RelativeDerivationPath

fn clone(&self) -> RelativeDerivationPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelativeDerivationPath

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

Formats the value using the given formatter.

impl Default for RelativeDerivationPath

fn default() -> RelativeDerivationPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RelativeDerivationPath

fn deserialize<D>(deserializer: D) -> Result<RelativeDerivationPath, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelativeDerivationPath

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

Formats the value using the given formatter.

impl Eq for RelativeDerivationPath

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

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

Converts to this type from the input type.

impl From<AbsoluteDerivationPath> for RelativeDerivationPath

fn from(path: AbsoluteDerivationPath) -> Self

Converts to this type from the input type.

impl From<RelativeDerivationPath> for Vec<ChildNumber>

fn from(path: RelativeDerivationPath) -> Self

Converts to this type from the input type.

impl From<RelativeDerivationPath> for AbsoluteDerivationPath

fn from(path: RelativeDerivationPath) -> Self

Converts to this type from the input type.

impl From<Vec<ChildNumber>> for RelativeDerivationPath

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

Converts to this type from the input type.

impl FromIterator<ChildNumber> for RelativeDerivationPath

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = ChildNumber>,

Creates a value from an iterator.

impl FromStr for RelativeDerivationPath

type Err = ParseDerivationPathError

The associated error which can be returned from parsing.

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

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

impl Hash for RelativeDerivationPath

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> Index<I> for RelativeDerivationPath

where Vec<ChildNumber>: Index<I>,

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

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a RelativeDerivationPath

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 Ord for RelativeDerivationPath

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RelativeDerivationPath

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for RelativeDerivationPath

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RelativeDerivationPath

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RelativeDerivationPath