Struct HardenedIndex

pub struct HardenedIndex(/* private fields */);

Index for hardened children derivation; ensures that the index always >= 2^31.

Implementations

impl HardenedIndex

pub const fn hardened(child_number: u16) -> HardenedIndex

Trait Implementations

impl Clone for HardenedIndex

fn clone(&self) -> HardenedIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HardenedIndex

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

Formats the value using the given formatter.

impl Default for HardenedIndex

fn default() -> HardenedIndex

Returns the “default value” for a type.

impl Display for HardenedIndex

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

Formats the value using the given formatter.

impl From<HardenedIndex> for DerivationIndex

fn from(v: HardenedIndex) -> DerivationIndex

Converts to this type from the input type.

impl From<u16> for HardenedIndex

fn from(v: u16) -> HardenedIndex

Converts to this type from the input type.

impl From<u8> for HardenedIndex

fn from(v: u8) -> HardenedIndex

Converts to this type from the input type.

impl FromStr for HardenedIndex

type Err = IndexParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HardenedIndex, <HardenedIndex as FromStr>::Err>

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

impl Hash for HardenedIndex

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Idx for HardenedIndex

const ZERO: HardenedIndex

Derivation path segment with index equal to zero.

const ONE: HardenedIndex

Derivation path segment with index equal to one.

const MAX: HardenedIndex

Derivation path segment with index equal to maximum value.

fn from_child_number(child_no: impl Into<u16>) -> HardenedIndex

Constructs index from a given child number.

fn try_from_child_number( child_no: impl Into<u32>, ) -> Result<HardenedIndex, IndexError>

Constructs index from a given child number.

fn try_from_index(index: u32) -> Result<HardenedIndex, IndexError>

Constructs derivation path segment with specific derivation value, which for normal indexes must lie in range 0..HARDENED_INDEX_BOUNDARY and for hardened in range of HARDENED_INDEX_BOUNDARY..=u32::MAX

fn checked_add_assign(&mut self, add: impl Into<u32>) -> Option<HardenedIndex>

Mutates the self by adding value the index; fails if the index value overflow happens.

fn checked_sub_assign(&mut self, sub: impl Into<u32>) -> Option<HardenedIndex>

Mutates the self by subtracting value the index; fails if the index value overflow happens.

const MIN: Self = Self::ZERO

Derivation path segment with index equal to minimal value.

const RANGE: Range<Self> = _

Range covering all possible index values.

fn to_be_bytes(&self) -> [u8; 4]

fn checked_inc(&self) -> Option<Self>

Increments the index on one step; fails if the index value is already maximum value.

fn checked_dec(&self) -> Option<Self>

Decrements the index on one step; fails if the index value is already minimum value.

fn saturating_inc(&self) -> Self

Increments the index on one step saturating at the Self::MAX bounds instead of overflowing.

fn saturating_dec(&self) -> Self

Decrements the index on one step saturating at the Self::MIN bounds instead of overflowing.

fn wrapping_inc(&self) -> Self

Increments the index on one step; fails if the index value is already maximum value.

fn wrapping_dec(&self) -> Self

Decrements the index on one step; fails if the index value is already minimum value.

fn checked_inc_assign(&mut self) -> Option<Self>

Mutates the self by incrementing the index on one step; fails if the index value is already maximum value.

fn checked_dec_assign(&mut self) -> Option<Self>

Mutates the self by decrementing the index on one step; fails if the index value is already maximum value.

fn saturating_inc_assign(&mut self) -> bool

Mutates the self by incrementing the index on one step, saturating at the Self::MAX bounds instead of overflowing.

fn saturating_dec_assign(&mut self) -> bool

Mutates the self by decrementing the index on one step, saturating at the Self::MIN bounds instead of overflowing.

fn wrapping_inc_assign(&mut self)

Mutates the self by incrementing the index on one step; fails if the index value is already maximum value.

fn wrapping_dec_assign(&mut self)

Mutates the self by decrementing the index on one step; fails if the index value is already maximum value.

fn checked_add(&self, add: impl Into<u32>) -> Option<Self>

Adds value the index; fails if the index value overflow happens.

fn checked_sub(&self, sub: impl Into<u32>) -> Option<Self>

Subtracts value the index; fails if the index value overflow happens.

fn saturating_add(&self, add: impl Into<u32>) -> Self

Saturating index addition. Computes self + add, saturating at the Self::MAX bounds instead of overflowing.

fn saturating_sub(&self, sub: impl Into<u32>) -> Self

Saturating index subtraction. Computes self - add, saturating at the Self::MIN bounds instead of overflowing.

fn saturating_add_assign(&mut self, add: impl Into<u32>) -> bool

Mutates the self by adding value the index saturating it at the Self::MAX value in case of overflow. Returns boolean value indicating if no overflow had happened.

fn saturating_sub_assign(&mut self, sub: impl Into<u32>) -> bool

Mutates the self by subtracting value from the index saturating it at the Self::MIN value in case of overflow. Returns boolean value indicating if no overflow had happened.

impl IdxBase for HardenedIndex

fn child_number(&self) -> u32

Returns hardened index number not offset by HARDENED_INDEX_BOUNDARY (i.e. zero-based).

fn index(&self) -> u32

Returns hardened index number offset by HARDENED_INDEX_BOUNDARY.

fn is_hardened(&self) -> bool

Detects whether path segment uses hardened index(es)

impl Ord for HardenedIndex

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<u16> for HardenedIndex

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq<u8> for HardenedIndex

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

Tests for self and other values to be equal, and is used by ==.

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 PartialEq for HardenedIndex

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

Tests for self and other values to be equal, and is used by ==.

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 PartialOrd<u16> for HardenedIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd<u8> for HardenedIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd for HardenedIndex

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<DerivationIndex> for HardenedIndex

type Error = IndexError

The type returned in the event of a conversion error.

fn try_from( idx: DerivationIndex, ) -> Result<HardenedIndex, <HardenedIndex as TryFrom<DerivationIndex>>::Error>

Performs the conversion.

impl Copy for HardenedIndex

impl Eq for HardenedIndex

impl StructuralPartialEq for HardenedIndex