Struct HDPathBuilder

pub struct HDPathBuilder {
    pub purpose: Option<u32>,
    pub purpose_hardened: bool,
    pub coin_type: Option<u32>,
    pub coin_type_hardened: bool,
    pub account: Option<u32>,
    pub account_hardened: bool,
    pub change: Option<u32>,
    pub change_hardened: bool,
    pub address_index: Option<u32>,
    pub address_index_hardened: bool,
}

A builder for the HDPath struct, it allows specification of the standard full path and also which components are hardened. The default implementation uses the standard format for the full path.

Fields

purpose: Option<u32>

purpose shortform index value, default is None, it should be specified based on the HDPurpose

purpose_hardened: bool

boolean indicating if the purpose index is hardened or not, default is true (hardened)

coin_type: Option<u32>

coin_type shortform index value, default is None, it should be specified based on the coin

coin_type_hardened: bool

boolean indicating if the coin_type index is hardened or not, default is true (hardened)

account: Option<u32>

account shortform index value, default is Some(0)

account_hardened: bool

boolean indicating if the account index is hardened or not, default is true (hardened)

change: Option<u32>

change shortform index value, default is Some(0)

change_hardened: bool

boolean indicating if the change index is hardened or not, default is false (not hardened)

address_index: Option<u32>

address_index shortform index value, default is Some(0)

address_index_hardened: bool

boolean indicating if the address_index index is hardened or not, default is false (not hardened)

Implementations

impl HDPathBuilder

pub fn new() -> HDPathBuilder

Creates a new HDPathBuilder with default values

pub fn purpose_index(&mut self, purpose: u32) -> &mut HDPathBuilder

Specify the purpose index shortform number value

pub fn hardened_purpose(&mut self) -> &mut HDPathBuilder

Specify that the purpose index should be hardened

pub fn non_hardened_purpose(&mut self) -> &mut HDPathBuilder

Specify that the purpose index should not be hardened

pub fn coin_type_index(&mut self, coin_type: u32) -> &mut HDPathBuilder

Specify the coin_type index shortform number value

pub fn hardened_coin_type(&mut self) -> &mut HDPathBuilder

Specify that the coin type index should be hardened

pub fn non_hardened_coin_type(&mut self) -> &mut HDPathBuilder

Specify that the coin type index should not be hardened

pub fn account_index(&mut self, account: u32) -> &mut HDPathBuilder

Specify the account index shortform number value

pub fn hardened_account(&mut self) -> &mut HDPathBuilder

Specify that the account index should be hardened

pub fn non_hardened_account(&mut self) -> &mut HDPathBuilder

Specify that the account index should not be hardened

pub fn change_index(&mut self, change: u32) -> &mut HDPathBuilder

Specify the change index shortform number value

pub fn hardened_change(&mut self) -> &mut HDPathBuilder

Specify that the change index should be hardened

pub fn non_hardened_change(&mut self) -> &mut HDPathBuilder

Specify that the change index should not be hardened

pub fn address_index(&mut self, address_index: u32) -> &mut HDPathBuilder

Specify the address_index index shortform number value

pub fn hardened_address(&mut self) -> &mut HDPathBuilder

Specify that the address index should be hardened

pub fn non_hardened_address(&mut self) -> &mut HDPathBuilder

Specify that the address index should not be hardened

pub fn no_purpose_index(&mut self) -> &mut HDPathBuilder

Set the purpose index to None

pub fn no_coin_type_index(&mut self) -> &mut HDPathBuilder

Set the coin_type index to None

pub fn no_account_index(&mut self) -> &mut HDPathBuilder

Set the account index to None

pub fn no_change_index(&mut self) -> &mut HDPathBuilder

Set the change index to None

pub fn no_address_index(&mut self) -> &mut HDPathBuilder

Set the address_index index to None

pub fn build(&mut self) -> HDPath

Build the HDPath The HDPath will be built from the values specified in the builder The HDPath always starts with the Master index (m) The HDPath will go in order from purpose, coin_type, account, change, address_index

If the purpose is not set, the HDPath will return the HDPath with the Master index only If the coin_type is not set, the HDPath will return the HDPath with the Master and purpose index It will use the defaults for the account, change, and address_index unless if something else has been specified on the builder using the with or set functions. So in order to build a full HDPath going up to the address index, the purpose and coin_type must be set.

Trait Implementations

impl Clone for HDPathBuilder

fn clone(&self) -> HDPathBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HDPathBuilder

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

Formats the value using the given formatter.

impl Default for HDPathBuilder

fn default() -> HDPathBuilder

Returns the “default value” for a type.

impl PartialEq for HDPathBuilder

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

impl StructuralPartialEq for HDPathBuilder