Struct DerivationPath

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

A BIP-32 derivation path.

Implementations

impl DerivationPath

pub fn new(path: String) -> Result<Self, Bip32Error>

Parse a string as a BIP-32 derivation path.

pub fn master() -> Arc<Self>

Returns derivation path for a master key (i.e. empty derivation path)

pub fn is_master(&self) -> bool

Returns whether derivation path represents master key (i.e. it’s length is empty). True for m path.

pub fn len(&self) -> u64

Returns length of the derivation path

pub fn is_empty(&self) -> bool

Returns true if the derivation path is empty

pub fn child(&self, child_number: ChildNumber) -> Result<Arc<Self>, Bip32Error>

Create a new DerivationPath that is a child of this one.

pub fn extend(&self, other: &DerivationPath) -> Arc<Self>

Concatenate self with path and return the resulting new path.

pub fn to_u32_vec(&self) -> Vec<u32>

Returns the derivation path as a vector of u32 integers. Unhardened elements are copied as is. 0x80000000 is added to the hardened elements.

Trait Implementations

impl Clone for DerivationPath

fn clone(&self) -> DerivationPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DerivationPath

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

Formats the value using the given formatter.

impl Display for DerivationPath

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

Formats the value using the given formatter.

impl From<DerivationPath> for DerivationPath

fn from(core_type: BdkDerivationPath) -> Self

Converts to this type from the input type.

impl From<DerivationPath> for DerivationPath

fn from(ffi_type: DerivationPath) -> Self

Converts to this type from the input type.

impl<UT> LiftRef<UT> for DerivationPath

type LiftType = Arc<DerivationPath>

impl<UT> LowerError<UT> for DerivationPath

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for DerivationPath

type ReturnType = <Arc<DerivationPath> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for DerivationPath

const TYPE_ID_META: MetadataBuffer