Enum bitcoin::util::bip32::ChildNumber

pub enum ChildNumber {
    Normal {
        index: u32,
    },
    Hardened {
        index: u32,
    },
}

A child number for a derived key

Variants

Normal

Non-hardened key

Fields of Normal

index: u32

Key index, within [0, 2^31 - 1]

Hardened

Hardened key

Fields of Hardened

index: u32

Key index, within [0, 2^31 - 1]

Methods

impl ChildNumber

pub fn from_normal_idx(index: u32) -> Result<Self, Error>

Create a Normal from an index, returns an error if the index is not within [0, 2^31 - 1].

pub fn from_hardened_idx(index: u32) -> Result<Self, Error>

Create a Hardened from an index, returns an error if the index is not within [0, 2^31 - 1].

pub fn is_normal(&self) -> bool

Returns true if the child number is a Normal value.

pub fn is_hardened(&self) -> bool

Returns true if the child number is a Hardened value.

Trait Implementations

impl Copy for ChildNumber

impl PartialEq<ChildNumber> for ChildNumber

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

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

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

This method tests for !=.

impl From<u32> for ChildNumber

fn from(number: u32) -> Self

Performs the conversion.

impl From<ChildNumber> for u32

fn from(cnum: ChildNumber) -> Self

Performs the conversion.

impl Clone for ChildNumber

fn clone(&self) -> ChildNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for ChildNumber

impl Display for ChildNumber

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

Formats the value using the given formatter.

impl Debug for ChildNumber

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

Formats the value using the given formatter.

impl FromIterator<ChildNumber> for DerivationPath

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = ChildNumber>, 

Creates a value from an iterator.

impl FromStr for ChildNumber

type Err = Error

The associated error which can be returned from parsing.

fn from_str(inp: &str) -> Result<ChildNumber, Error>

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