Struct KeypathRef 

pub struct KeypathRef<'a> {
    pub components: PathComponents<'a>,
    pub source_fingerprint: Option<NonZeroU32>,
    pub depth: Option<u8>,
}

Metadata for the complete or partial derivation path of a key (non-owned, zero copy).

Fields

components: PathComponents<'a>

Path component.

source_fingerprint: Option<NonZeroU32>

Fingerprint from the ancestor key.

depth: Option<u8>

How many derivations this key is from the master (which is 0).

Implementations

impl<'a> KeypathRef<'a>

pub fn new_master(source_fingerprint: NonZeroU32) -> Self

Create a new key path for a master extended public key.

The source_fingerprint parameter is the fingerprint of the master key.

Trait Implementations

impl<'a> Clone for KeypathRef<'a>

fn clone(&self) -> KeypathRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for KeypathRef<'a>

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

Formats the value using the given formatter.

impl<'b, C> Decode<'b, C> for KeypathRef<'b>

fn decode(d: &mut Decoder<'b>, ctx: &mut C) -> Result<Self, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl<'a, C> Encode<C> for KeypathRef<'a>

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl<'a> From<&'a DerivationPath> for KeypathRef<'a>

Available on crate feature bitcoin only.

fn from(derivation_path: &'a DerivationPath) -> Self

Converts to this type from the input type.

impl<'a> From<KeypathRef<'a>> for Keypath

Available on crate feature alloc only.

fn from(keypath: KeypathRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for KeypathRef<'a>

fn eq(&self, other: &KeypathRef<'a>) -> 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<'a> StructuralPartialEq for KeypathRef<'a>