Struct AbsoluteDerivationPath 

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

An absolute BIP-0032 derivation path, starting at the master key.

Conversion to RelativeDerivationPath is available through AbsoluteDerivationPath::as_relative or AbsoluteDerivationPath::into_relative.

The leading m in BIP-0032 notation has historically been subtle in this crate: See PR #2451 and PR #2677 for prior discussion on the “m/” notation.

Implementations

impl AbsoluteDerivationPath

pub fn master() -> Self

Returns the absolute derivation path for a master key.

pub fn is_master(&self) -> bool

Returns true if this is the master path.

pub fn as_relative(&self) -> &RelativeDerivationPath

Returns the relative path below the master key.

pub fn into_relative(self) -> RelativeDerivationPath

Converts this absolute path into the relative path below the master key.

pub fn len(&self) -> usize

Returns length of the relative derivation path below the master key.

pub fn is_empty(&self) -> bool

Returns true if this is the master path.

pub fn contains_hardened_child(&self) -> bool

Returns true if the relative path below the master key contains a hardened child number.

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

Joins self with path and returns the resulting new path.

Trait Implementations

impl<'a> Arbitrary<'a> for AbsoluteDerivationPath

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 Clone for AbsoluteDerivationPath

fn clone(&self) -> AbsoluteDerivationPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AbsoluteDerivationPath

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

Formats the value using the given formatter.

impl Default for AbsoluteDerivationPath

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AbsoluteDerivationPath

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AbsoluteDerivationPath

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

Formats the value using the given formatter.

impl Eq for AbsoluteDerivationPath

impl From<AbsoluteDerivationPath> for RelativeDerivationPath

fn from(path: AbsoluteDerivationPath) -> Self

Converts to this type from the input type.

impl From<RelativeDerivationPath> for AbsoluteDerivationPath

fn from(path: RelativeDerivationPath) -> Self

Converts to this type from the input type.

impl FromStr for AbsoluteDerivationPath

type Err = ParseDerivationPathError

The associated error which can be returned from parsing.

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

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

impl Hash for AbsoluteDerivationPath

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 Ord for AbsoluteDerivationPath

fn cmp(&self, other: &AbsoluteDerivationPath) -> 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 AbsoluteDerivationPath

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

fn partial_cmp(&self, other: &AbsoluteDerivationPath) -> 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 AbsoluteDerivationPath

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 AbsoluteDerivationPath