Struct hdpath::CustomHDPath

pub struct CustomHDPath(pub Vec<PathValue>);

A custom HD Path, that can be any length and contain any Hardened and non-Hardened values in any order. Direct implementation for BIP-32

If you need just standard type of HD Path like m/44'/0'/0'/0/0 use StandardHDPath instead.

Usage

Parse string

use hdpath::CustomHDPath;

let hdpath = CustomHDPath::try_from("m/1'/2'/3/4/5'/6'/7").unwrap();
let hdpath = CustomHDPath::try_from("m/44'/0'/1'/0/0").unwrap();
//also support uppercase notation
let hdpath = CustomHDPath::try_from("M/44H/0H/1H/0/0").unwrap();

Direct create

use hdpath::{CustomHDPath, PathValue};

let hdpath = CustomHDPath::try_new(vec![
   PathValue::hardened(44), PathValue::hardened(0), PathValue::hardened(1),
   PathValue::normal(0), PathValue::normal(0)
]).unwrap();

Tuple Fields

0: Vec<PathValue>

Implementations

impl CustomHDPath

pub fn try_new(values: Vec<PathValue>) -> Result<CustomHDPath, Error>

Create a new HD Path.

Returns error only if provided vector is too large, i.e. more than 255 elements (since BIP-32 says about ability to encode depth in a single byte).

Trait Implementations

impl Clone for CustomHDPath

fn clone(&self) -> CustomHDPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomHDPath

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

Formats the value using the given formatter.

impl Display for CustomHDPath

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

Formats the value using the given formatter.

impl From<&'_ (dyn HDPath + '_)> for CustomHDPath

fn from(value: &dyn HDPath) -> Self

Converts to this type from the input type.

impl From<StandardHDPath> for CustomHDPath

fn from(value: StandardHDPath) -> Self

Converts to this type from the input type.

impl FromStr for CustomHDPath

type Err = Error

The associated error which can be returned from parsing.

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

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

impl HDPath for CustomHDPath

fn len(&self) -> u8

Size of the HD Path

fn get(&self, pos: u8) -> Option<PathValue>

Get element as the specified position. The implementation must return Some<PathValue> for all values up to len(). And return None if the position if out of bounds.

fn to_bytes(&self) -> Vec<u8>

Encode as bytes, where first byte is number of elements in path (always 5 for StandardHDPath) following by 4-byte BE values

fn parent(&self) -> Option<CustomHDPath>

Get parent HD Path. Return None if the current path is empty (i.e. already at the top)

fn as_custom(&self) -> CustomHDPath

Convert current to CustomHDPath structure

impl PartialEq<CustomHDPath> for CustomHDPath

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

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

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

This method tests for !=.

impl TryFrom<&'_ str> for CustomHDPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CustomHDPath> for AccountHDPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CustomHDPath) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CustomHDPath> for StandardHDPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: CustomHDPath) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CustomHDPath

impl StructuralEq for CustomHDPath

impl StructuralPartialEq for CustomHDPath