Enum hdwallet::extended_key::key_index::KeyIndex

pub enum KeyIndex {
    Normal(u32),
    Hardened(u32),
}

KeyIndex indicates the key type and index of a child key.

Variants

Normal(u32)

Normal key, index range is from 0 to 2 ** 31 - 1

Hardened(u32)

Hardened key, index range is from 2 ** 31 to 2 ** 32 - 1

Methods

impl KeyIndex

pub fn raw_index(self) -> u32

Return raw index value

pub fn normalize_index(self) -> u32

Return normalize index, it will return index subtract 2 ** 31 for hardended key.

Examples

use hdwallet::KeyIndex;

assert_eq!(KeyIndex::Normal(0).normalize_index(), 0);
assert_eq!(KeyIndex::Hardened(2_147_483_648).normalize_index(), 0);

pub fn is_valid(self) -> bool

Check index range.

Examples

use hdwallet::KeyIndex;

assert!(KeyIndex::Normal(0).is_valid());
assert!(!KeyIndex::Normal(2_147_483_648).is_valid());
assert!(KeyIndex::Hardened(2_147_483_648).is_valid());

pub fn hardened_from_normalize_index(i: u32) -> Result<KeyIndex, Error>

Generate Hardened KeyIndex from normalize index value.

Examples

use hdwallet::KeyIndex;

// hardended key from zero
let hardened_index_zero = KeyIndex::hardened_from_normalize_index(0).unwrap();
assert_eq!(hardened_index_zero, KeyIndex::Hardened(2_147_483_648));
// also allow raw index for convernient
let hardened_index_zero = KeyIndex::hardened_from_normalize_index(2_147_483_648).unwrap();
assert_eq!(hardened_index_zero, KeyIndex::Hardened(2_147_483_648));

pub fn from_index(i: u32) -> Result<Self, Error>

Generate KeyIndex from raw index value.

Examples

use hdwallet::KeyIndex;

let normal_key = KeyIndex::from_index(0).unwrap();
assert_eq!(normal_key, KeyIndex::Normal(0));
let hardened_key = KeyIndex::from_index(2_147_483_648).unwrap();
assert_eq!(hardened_key, KeyIndex::Hardened(2_147_483_648));

Trait Implementations

impl Copy for KeyIndex

impl PartialEq<KeyIndex> for KeyIndex

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

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

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

This method tests for !=.

impl From<u32> for KeyIndex

fn from(index: u32) -> Self

Performs the conversion.

impl Clone for KeyIndex

fn clone(&self) -> KeyIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for KeyIndex

impl Debug for KeyIndex

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

Formats the value using the given formatter.