Struct hdpath::StandardHDPath

pub struct StandardHDPath { /* private fields */ }

Standard HD Path for BIP-44, BIP-49, BIP-84 and similar. For path as m/purpose'/coin_type'/account'/change/address_index, like m/44'/0'/0'/0/0.

Create new

use hdpath::{StandardHDPath, Purpose};

//creates path m/84'/0'/0'/0/0
let hdpath = StandardHDPath::new(Purpose::Witness, 0, 0, 0, 0);

Parse string

use hdpath::{StandardHDPath, Purpose};

//creates path m/84'/0'/0'/0/0
let hdpath = StandardHDPath::from_str("m/84'/0'/0'/0/0").unwrap();

Implementations

impl StandardHDPath

pub fn new(
    purpose: Purpose,
    coin_type: u32,
    account: u32,
    change: u32,
    index: u32
) -> StandardHDPath

Create a standard HD Path. Panics if any of the values is incorrect

use hdpath::{StandardHDPath, Purpose};

let hdpath =  StandardHDPath::new(Purpose::Witness, 0, 2, 0, 0);

pub fn try_new(
    purpose: Purpose,
    coin_type: u32,
    account: u32,
    change: u32,
    index: u32
) -> Result<StandardHDPath, (String, u32)>

Try to create a standard HD Path. Return error (field_name, invalid_value) if a field has an incorrect value.

use hdpath::{StandardHDPath, Purpose};


let index = 0x80000100; //received from unreliable source
match StandardHDPath::try_new(Purpose::Witness, 0, 2, 0, index) {
    Ok(hdpath) => { }
    Err(err) => println!("Invalid value {} = {}", err.0, err.1)
}

pub fn purpose(&self) -> &Purpose

pub fn coin_type(&self) -> u32

pub fn account(&self) -> u32

pub fn change(&self) -> u32

pub fn index(&self) -> u32

pub fn from_bytes(path: &[u8]) -> Result<Self, Error>

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

Trait Implementations

impl Clone for StandardHDPath

fn clone(&self) -> StandardHDPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StandardHDPath

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

Formats the value using the given formatter.

impl Default for StandardHDPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for StandardHDPath

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

Formats the value using the given formatter.

impl From<&'_ StandardHDPath> for AccountHDPath

fn from(value: &StandardHDPath) -> Self

Converts to this type from the input type.

impl From<StandardHDPath> for AccountHDPath

fn from(value: StandardHDPath) -> 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 StandardHDPath

type Err = Error

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 HDPath for StandardHDPath

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

fn cmp(&self, other: &StandardHDPath) -> 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

Restrict a value to a certain interval.

impl PartialEq<StandardHDPath> for StandardHDPath

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

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

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

This method tests for !=.

impl PartialOrd<StandardHDPath> for StandardHDPath

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

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

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

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

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

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

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

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

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

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

impl TryFrom<&'_ str> for StandardHDPath

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 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 StandardHDPath

impl StructuralEq for StandardHDPath

impl StructuralPartialEq for StandardHDPath