Struct PathComponent 

pub struct PathComponent { /* private fields */ }

Available on crate feature mnemonic only.

A single component of a BIP-32 derivation path.

Wraps a 31-bit numeric index plus a hardened flag. The encoded 32-bit value used during derivation is index | 0x80000000 when hardened.

Fields are private to enforce the index < 2^31 invariant: a value with the hardened bit already set would collide with an explicitly hardened component during BIP-32 derivation, producing an ambiguous key. Use Self::try_new to construct.

Implementations

impl PathComponent

pub fn try_new(index: u32, hardened: bool) -> AptosResult<Self>

Constructs a path component, rejecting any index whose top bit is set (i.e. index >= 2^31 = 0x8000_0000).

Errors

Returns AptosError::KeyDerivation if index has its hardened bit set; valid BIP-32 indices are confined to 31 bits and the hardened bit is supplied via the hardened flag.

pub fn index(self) -> u32

Returns the 31-bit numeric index without the hardened bit applied.

pub fn hardened(self) -> bool

Returns true when this component is hardened (encoded as index | 0x80000000 during derivation).

pub fn encoded(self) -> u32

Encodes this component as the 32-bit value passed to BIP-32 / SLIP-0010 child-key derivation (i.e. with the hardened bit set when applicable).

Trait Implementations

impl Clone for PathComponent

fn clone(&self) -> PathComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathComponent

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

Formats the value using the given formatter.

impl PartialEq for PathComponent

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

impl Eq for PathComponent

impl StructuralPartialEq for PathComponent