Enum derivation_path::ChildIndex

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

An index in a DerivationPath

Variants

Normal(u32)

Hardened(u32)

Implementations

impl ChildIndex

pub fn hardened(num: u32) -> Result<Self, ChildIndexError>

Create a ChildIndex::Hardened instance from a u32. This will fail if num is not in [0, 2^31 - 1]

pub fn normal(num: u32) -> Result<Self, ChildIndexError>

Create a ChildIndex::Normal instance from a u32. This will fail if num is not in [0, 2^31 - 1]

pub fn to_u32(self) -> u32

Convert ChildIndex to its inner u32

pub fn to_bits(self) -> u32

Convert ChildIndex to a u32 representing the type and a 31 bit number. The highest bit is set for a hard derivation and clear for a normal derivation, and the remaining 31 bits are the index

pub fn from_bits(bits: u32) -> Self

Build a ChildIndex from a u32 representing the type and a 31 bit number. See ChildIndex::to_bits for more information

pub fn is_hardened(self) -> bool

Check if the ChildIndex is "hardened"

pub fn is_normal(self) -> bool

Check if the ChildIndex is "normal"

Trait Implementations

impl Clone for ChildIndex

fn clone(&self) -> ChildIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChildIndex

impl Debug for ChildIndex

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

Formats the value using the given formatter.

impl Display for ChildIndex

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

Formats the value using the given formatter.

impl Eq for ChildIndex

impl FromStr for ChildIndex

type Err = ChildIndexParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Ord for ChildIndex

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<ChildIndex> for ChildIndex

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

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

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

This method tests for !=.

impl PartialOrd<ChildIndex> for ChildIndex

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ChildIndex

impl StructuralPartialEq for ChildIndex