Struct farcaster_core::crypto::slip10::DerivationPath

pub struct DerivationPath(_);

Available on crate feature experimental only.

A BIP-32 derivation path.

Implementations

impl DerivationPath

pub fn len(&self) -> usize

Returns length of the derivation path

pub fn is_empty(&self) -> bool

Returns true if the derivation path is empty

pub fn master() -> DerivationPath

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 child(&self, cn: ChildNumber) -> DerivationPath

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

pub fn into_child(self, cn: ChildNumber) -> DerivationPath

Convert into a DerivationPath that is a child of this one.

pub fn children_from(&self, cn: ChildNumber) -> DerivationPathIterator<'_>

Get an Iterator over the children of this DerivationPath starting with the given ChildNumber.

pub fn normal_children(&self) -> DerivationPathIterator<'_>

Get an Iterator over the unhardened children of this DerivationPath.

pub fn hardened_children(&self) -> DerivationPathIterator<'_>

Get an Iterator over the hardened children of this DerivationPath.

pub fn extend<T>(&self, path: T) -> DerivationPathwhere
    T: AsRef<[ChildNumber]>,

Concatenate self with path and return the resulting new path.

use bitcoin::util::bip32::{DerivationPath, ChildNumber};
use std::str::FromStr;

let base = DerivationPath::from_str("m/42").unwrap();

let deriv_1 = base.extend(DerivationPath::from_str("m/0/1").unwrap());
let deriv_2 = base.extend(&[
    ChildNumber::from_normal_idx(0).unwrap(),
    ChildNumber::from_normal_idx(1).unwrap()
]);

assert_eq!(deriv_1, deriv_2);

Trait Implementations

impl AsRef<[ChildNumber]> for DerivationPath

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

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

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<(), Error>

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 as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DerivationPath

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

Formats the value using the given formatter.

impl<'a> From<&'a [ChildNumber]> for DerivationPath

fn from(numbers: &'a [ChildNumber]) -> DerivationPath

Converts to this type from the input type.

impl From<Vec<ChildNumber, Global>> for DerivationPath

fn from(numbers: Vec<ChildNumber, Global>) -> DerivationPath

Converts to this type from the input type.

impl FromIterator<ChildNumber> for DerivationPath

fn from_iter<T>(iter: T) -> DerivationPathwhere
    T: IntoIterator<Item = ChildNumber>,

Creates a value from an iterator.

impl FromStr for DerivationPath

type Err = Error

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<DerivationPath, Error>

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

impl Hash for DerivationPath

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<I> Index<I> for DerivationPathwhere
    Vec<ChildNumber, Global>: Index<I>,

type Output = <Vec<ChildNumber, Global> as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<DerivationPath as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl Into<Vec<ChildNumber, Global>> for DerivationPath

fn into(self) -> Vec<ChildNumber, Global>

Converts this type into the (usually inferred) input type.

impl<'a> IntoIterator for &'a DerivationPath

type Item = &'a ChildNumber

The type of the elements being iterated over.

type IntoIter = Iter<'a, ChildNumber>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a DerivationPath as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Ord for DerivationPath

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'de> Serialize for DerivationPath

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

Serialize this value into the given Serde serializer.

impl StrictDecode for DerivationPath

fn strict_decode<D>(d: D) -> Result<DerivationPath, Error>where
    D: Read,

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for DerivationPath

fn strict_encode<E>(&self, e: E) -> Result<usize, Error>where
    E: Write,

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for DerivationPath

impl StructuralEq for DerivationPath

impl StructuralPartialEq for DerivationPath