Struct coins_bip32::path::KeyDerivation

pub struct KeyDerivation {
    pub root: KeyFingerprint,
    pub path: DerivationPath,
}

A Derivation Path for a bip32 key

Fields

root: KeyFingerprint

The root key fingerprint

path: DerivationPath

The derivation path from the root key

Implementations

impl KeyDerivation

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

true if the keys share a root fingerprint, false otherwise. Note that on key fingerprints, which may collide accidentally, or be intentionally collided.

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

true if this key is an ancestor of other, false otherwise. Note that on key fingerprints, which may collide accidentally, or be intentionally collided.

pub fn path_to_descendant(&self, descendant: &Self) -> Option<DerivationPath>

Returns the path to the decendant.

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 ByteFormat for KeyDerivation

type Error = Bip32Error

An associated error type

fn serialized_length(&self) -> usize

Returns the byte-length of the serialized data structure.

fn read_from<T>(_reader: &mut T) -> Result<Self, Self::Error>

where T: Read, Self: Sized,

Deserializes an instance of Self from a std::io::Read. The limit argument is used only when deserializing collections, and specifies a maximum number of instances of the underlying type to read.

fn write_to<T>(&self, writer: &mut T) -> Result<usize, Self::Error>

where T: Write,

Serializes self to a std::io::Write. Following Write trait conventions, its Ok type must be a usize denoting the number of bytes written.

fn read_seq_from<R>( reader: &mut R, mode: ReadSeqMode, ) -> Result<Vec<Self>, Self::Error>

where R: Read, Self: Sized,

Read a sequence of objects from the reader. The mode argument specifies how many objects to read.

fn write_seq_to<'a, W, E, Iter, Item>( writer: &mut W, iter: Iter, ) -> Result<usize, Self::Error>

where W: Write, E: Into<Self::Error> + From<SerError> + From<Error> + Error, Item: 'a + ByteFormat<Error = E>, Iter: IntoIterator<Item = &'a Item>,

Write a sequence of ByteFormat objects to a writer. The iter argument may be any object that implements IntoIterator<Item = &Item>. This means we can seamlessly use vectors, slices, etc.

fn deserialize_hex(s: &str) -> Result<Self, Self::Error>

where Self: Sized,

Decodes a hex string to a Vec<u8>, deserializes an instance of Self from that vector.

fn deserialize_base64(s: &str) -> Result<Self, Self::Error>

where Self: Sized,

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

fn serialize_hex(&self) -> String

Serializes self to a vector, returns the hex-encoded vector

fn serialize_base64(&self) -> String

Serialize self to a base64 string, using standard RFC4648 non-url safe characters

impl Clone for KeyDerivation

fn clone(&self) -> KeyDerivation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDerivation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyDerivation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyDerivation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyDerivation

impl StructuralPartialEq for KeyDerivation