Struct ChildNumber 

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

A child number for a derived key.

The high bit marks whether the index is hardened and the remaining bits store the actual index.

Implementations

impl ChildNumber

pub const ZERO_NORMAL: Self

Normal child number with index 0.

pub const ONE_NORMAL: Self

Normal child number with index 1.

pub const ZERO_HARDENED: Self

Hardened child number with index 0.

pub const ONE_HARDENED: Self

Hardened child number with index 1.

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

Constructs a new normal child number from an index.

Errors

Returns an error if the index is not within [0, 2^31 - 1].

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

Constructs a new hardened child number from an index.

Errors

Returns an error if the index is not within [0, 2^31 - 1].

pub fn from_raw(raw: u32) -> Self

Constructs a child number from its raw BIP-0032 representation.

The raw representation includes the hardened bit. Use Self::from_normal_idx or Self::from_hardened_idx to construct a child number from an index.

pub fn to_raw(self) -> u32

Returns the raw BIP-0032 representation.

The raw representation includes the hardened bit. Use Self::index to get the child index without the hardened bit.

pub fn index(self) -> u32

Returns the child index, without the hardened bit.

pub fn is_normal(&self) -> bool

Returns true if the child number is not hardened.

pub fn is_hardened(&self) -> bool

Returns true if the child number is hardened.

pub fn increment(self) -> Result<Self, IndexOutOfRangeError>

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

Errors

Returns an error if the index after incrementing will be outside the range [0, 2^31 - 1].

Trait Implementations

impl<'a> Arbitrary<'a> for ChildNumber

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<[ChildNumber]> for ChildNumber

fn as_ref(&self) -> &[Self]

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for ChildNumber

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

Formats the value using the given formatter.

impl Clone for ChildNumber

fn clone(&self) -> ChildNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChildNumber

impl Debug for ChildNumber

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChildNumber

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChildNumber

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

Formats the value using the given formatter.

impl Eq for ChildNumber

impl From<ChildNumber> for u32

fn from(number: ChildNumber) -> Self

Converts to this type from the input type.

impl From<u32> for ChildNumber

fn from(number: u32) -> Self

Converts to this type from the input type.

impl FromIterator<ChildNumber> for RelativeDerivationPath

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = ChildNumber>,

Creates a value from an iterator.

impl FromStr for ChildNumber

type Err = ParseChildNumberError

The associated error which can be returned from parsing.

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

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

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for ChildNumber

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

Formats the value using the given formatter.

impl Octal for ChildNumber

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

Formats the value using the given formatter.

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

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

fn eq(&self, other: &ChildNumber) -> 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 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: &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 Serialize for ChildNumber

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChildNumber

impl UpperHex for ChildNumber

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

Formats the value using the given formatter.