Struct walletd_bitcoin::HDPath

pub struct HDPath { /* private fields */ }

Contains a vector of HDPathIndex to represent a derivation path for a HDKey and relevant helper functions.

Implementations

impl HDPath

pub fn new(path: &str) -> Result<HDPath, Error>

Creates a new HDPath from a string representation of the path.

pub fn push(&mut self, index: HDPathIndex)

Pushes a new HDPathIndex to the path

pub fn len(&self) -> usize

Returns the length of the path

pub fn is_empty(&self) -> bool

Returns true if the path is empty, false otherwise

pub fn derive_path_str_to_list( deriv_path: &str ) -> Result<Vec<String, Global>, Error>

Helper function to convert a derivation path string to a list of strings Returns Error if the path is empty or does not start with “m”

pub fn to_vec(&self) -> Vec<HDPathIndex, Global>

Returns the underlying vector of HDPathIndex

pub fn derive_path_str_to_info( deriv_path: &str ) -> Result<Vec<HDPathIndex, Global>, Error>

Helper function to convert a derivation path string to a vector of HDPathIndex Returns an Error variant if the derivation path string is invalid

pub fn builder() -> HDPathBuilder

Returns the builder for the HDPath (HDPathBuilder)

pub fn at(&self, index: usize) -> Result<HDPathIndex, Error>

Returns the HDPathIndex object at the specified position (index) in the path if it exists, otherwise returns an error

pub fn purpose(&self) -> Result<HDPurpose, Error>

Returns the HDPurpose value related to the purpose attribute, if it exists in the HDPath

Returns an error Error::IndexOutOfRange if the index 1 is not valid for the HDPath object

pub fn coin_type(&self) -> Result<HDPathIndex, Error>

Returns the HDPathIndex value related to the coin_type attribute, if it exists in the HDPath

Returns an error Error::IndexOutOfRange if the index is not valid for the HDPath object

pub fn account(&self) -> Result<HDPathIndex, Error>

Returns the HDPathIndex value related to the account attribute, if it exists in the HDPath

Returns an error Error::IndexOutOfRange if the index is not valid for the HDPath object

pub fn change(&self) -> Result<HDPathIndex, Error>

Returns the HDPathIndex value related to the change attribute, if it exists in the HDPath

Returns an error Error::IndexOutOfRange if the index is not valid for the HDPath object

pub fn address(&self) -> Result<HDPathIndex, Error>

Returns the HDPathIndex value related to the address attribute, if it exists in the HDPath

Returns an error Error::IndexOutOfRange if the index is not valid for the HDPath object

Trait Implementations

impl Clone for HDPath

fn clone(&self) -> HDPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HDPath

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

Formats the value using the given formatter.

impl Default for HDPath

fn default() -> HDPath

Returns the “default value” for a type.

impl Display for HDPath

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

Formats the value using the given formatter.

impl From<Vec<HDPathIndex, Global>> for HDPath

fn from(path: Vec<HDPathIndex, Global>) -> HDPath

Converts to this type from the input type.

impl FromStr for HDPath

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Ord for HDPath

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<HDPath> for HDPath

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

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

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.

impl PartialOrd<HDPath> for HDPath

fn partial_cmp(&self, other: &HDPath) -> 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 Eq for HDPath

impl StructuralEq for HDPath

impl StructuralPartialEq for HDPath