Struct hdpath::StandardHDPath

source ·
pub struct StandardHDPath { /* private fields */ }
Expand description

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§

source§

impl StandardHDPath

source

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);
source

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)
}
source

pub fn purpose(&self) -> &Purpose

source

pub fn coin_type(&self) -> u32

source

pub fn account(&self) -> u32

source

pub fn change(&self) -> u32

source

pub fn index(&self) -> u32

source

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§

source§

impl Clone for StandardHDPath

source§

fn clone(&self) -> StandardHDPath

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
source§

impl Debug for StandardHDPath

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for StandardHDPath

source§

fn default() -> Self

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

impl Display for StandardHDPath

source§

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

Formats the value using the given formatter. Read more
source§

impl From<&StandardHDPath> for AccountHDPath

source§

fn from(value: &StandardHDPath) -> Self

Converts to this type from the input type.
source§

impl From<StandardHDPath> for AccountHDPath

source§

fn from(value: StandardHDPath) -> Self

Converts to this type from the input type.
source§

impl From<StandardHDPath> for CustomHDPath

source§

fn from(value: StandardHDPath) -> Self

Converts to this type from the input type.
source§

impl FromStr for StandardHDPath

§

type Err = Error

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl HDPath for StandardHDPath

source§

fn len(&self) -> u8

Size of the HD Path
source§

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

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
source§

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

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

fn as_custom(&self) -> CustomHDPath

Convert current to CustomHDPath structure
source§

impl Hash for StandardHDPath

source§

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

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
source§

impl Ord for StandardHDPath

source§

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

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

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

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

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

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

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq<StandardHDPath> for StandardHDPath

source§

fn eq(&self, other: &StandardHDPath) -> 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.
source§

impl PartialOrd<StandardHDPath> for StandardHDPath

source§

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

impl TryFrom<&str> for StandardHDPath

§

type Error = Error

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

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

Performs the conversion.
source§

impl TryFrom<CustomHDPath> for StandardHDPath

§

type Error = Error

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

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

Performs the conversion.
source§

impl Eq for StandardHDPath

source§

impl StructuralEq for StandardHDPath

source§

impl StructuralPartialEq for StandardHDPath

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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.

source§

impl<T> ToOwned for Twhere 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 Twhere 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 Twhere 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 Twhere 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.