Enum HDPathIndex

pub enum HDPathIndex {
    Master,
    IndexHardened(u32),
    IndexNotHardened(u32),
}

Represents the variants of different derivation path components.

The HDPath struct contains a vector of these values.

Variants

Master

Master index is the root of the derivation tree, it is represented as m in the string path

IndexHardened(u32)

IndexHardened is a hardened index, it is represented as a number followed by ’ in the string path The number is the short form value, the full index value is the short form value + 2^31

IndexNotHardened(u32)

IndexNotHardened is a non-hardened index, it is represented as a number in the string path The number is the short form value, the full index value is the same short form value when the index is not hardened

Implementations

impl HDPathIndex

pub fn hardened_full_num(num: u32) -> u32

Convert to the full number used to represent a hardend index from the shortform number used in the derivation path string accompanied by ’ to indicate hardened

pub fn hardened_shortform_num(full_num: u32) -> u32

Convert from the full number used represent a hardened index to the shortform number which when accompanied by ’ indicates a hardened index

pub fn to_shortform_num(&self) -> u32

Returns the short form value of index. For master type always returns 0, for hardened index returns the short form value without the hardened indicator, the value here for hardened index is not the same as the full index number which is used in the calculation but rather the short form value used in the derivation string when accompanied by the ’ indicator For non-hardened index returns the the shortform number and full number are the same.

pub fn to_full_num(&self) -> u32

Returns the full index value, for non-hardened index this is the same as the short form value, for hardened index this is the full index value used in the calculation

pub fn new_master() -> HDPathIndex

Creates a master HDPathIndex

pub fn new_index(num: u32, hardened: bool) -> HDPathIndex

Creates a new index (not master) from the short form index and a boolean which indicates if the index is hardened or not

Arguments

• num - the short form index value, the value here for hardened index is not the same as the full index number which is used in the calculation but rather the short form value used in the derivation string when accompanied by the ’ indicator
• hardened - boolean indicating if the index is hardened or not

Trait Implementations

impl Clone for HDPathIndex

fn clone(&self) -> HDPathIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HDPathIndex

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

Formats the value using the given formatter.

impl Display for HDPathIndex

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

Formats the value using the given formatter.

impl From<&HDPurpose> for HDPathIndex

fn from(purpose: &HDPurpose) -> HDPathIndex

Converts to this type from the input type.

impl FromStr for HDPathIndex

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HDPathIndex, Error>

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

impl Ord for HDPathIndex

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

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

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

const 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 HDPathIndex

fn partial_cmp(&self, other: &HDPathIndex) -> 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 TryFrom<HDPathIndex> for HDPurpose

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path_index: HDPathIndex) -> Result<HDPurpose, Error>

Performs the conversion.

impl Copy for HDPathIndex

impl Eq for HDPathIndex

impl StructuralPartialEq for HDPathIndex