Struct coins_bip32::path::DerivationPath

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

A Bip32 derivation path

Implementations

impl DerivationPath

pub fn last(&self) -> Option<&u32>

Return the last index in the path. None if the path is the root.

pub fn derivation_string(&self) -> String

Converts the path to a standard bip32 string. e.g "m/44'/0'/0/32".

pub fn is_empty(&self) -> bool

Returns True if there are no indices in the path

pub fn len(&self) -> usize

The number of derivations in the path

pub fn iter(&self) -> Iter<'_, u32>

Make an iterator over the path indices

pub fn starts_with(&self, other: &Self) -> bool

true if other is a prefix of self

pub fn without_prefix(&self, prefix: &Self) -> Option<DerivationPath>

Remove a prefix from a derivation. Return a new DerivationPath without the prefix. This is useful for determining the path to rech some descendant from some ancestor.

pub fn last_hardened(&self) -> (usize, Option<u32>)

Convenience function for finding the last hardened derivation in a path. Returns the index and the element. If there is no hardened derivation, it will return (0, None).

pub fn resized(&self, size: usize, pad_with: u32) -> Self

Return a clone with a resized path. If the new size is shorter, this truncates it. If the new path is longer, we pad with the second argument.

pub fn extended(&self, idx: u32) -> Self

Append an additional derivation to the end, return a clone

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 Default for DerivationPath

fn default() -> DerivationPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DerivationPath

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&[u32]> for DerivationPath

fn from(v: &[u32]) -> Self

Converts to this type from the input type.

impl From<&DerivationPath> for DerivationPath

fn from(v: &DerivationPath) -> Self

Converts to this type from the input type.

impl From<&Vec<u32>> for DerivationPath

fn from(v: &Vec<u32>) -> Self

Converts to this type from the input type.

impl From<Vec<u32>> for DerivationPath

fn from(v: Vec<u32>) -> Self

Converts to this type from the input type.

impl FromIterator<u32> for DerivationPath

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

where T: IntoIterator<Item = u32>,

Creates a value from an iterator.

impl FromStr for DerivationPath

type Err = Bip32Error

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DerivationPath

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for DerivationPath

type Error = Bip32Error

The type returned in the event of a conversion error.

fn try_from(v: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for DerivationPath

type Error = Bip32Error

The type returned in the event of a conversion error.

fn try_from(v: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DerivationPath

impl StructuralPartialEq for DerivationPath