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.

pub fn increment(self) -> Result<ChildNumber, Error>

Returns the child number that is a single increment from this one.

Trait Implementations

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 Ord for ChildNumber

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<ChildNumber> for ChildNumber

fn partial_cmp(&self, other: &ChildNumber) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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 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 Eq for ChildNumber

impl Copy 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 Hash for ChildNumber

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

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.