Struct slip132::KeyVersion

pub struct KeyVersion(_);

Structure holding 4 version bytes with magical numbers representing different versions of extended public and private keys according to BIP-32. Key version stores raw bytes without their check, interpretation or verification; for these purposes special helpers structures implementing VersionResolver are used.

Implementations

impl KeyVersion

pub fn is_pub<R: VersionResolver>(&self) -> Option<bool>

Detects whether provided version corresponds to an extended public key. Returns None if the version is not recognized/unknown to the resolver.

pub fn is_prv<R: VersionResolver>(&self) -> Option<bool>

Detects whether provided version corresponds to an extended private key. Returns None if the version is not recognized/unknown to the resolver.

pub fn network<R: VersionResolver>(&self) -> Option<R::Network>

Detects network used by the provided key version bytes. Returns None if the version is not recognized/unknown to the resolver.

pub fn application<R: VersionResolver>(&self) -> Option<R::Application>

Detects application scope defined by the provided key version bytes. Application scope is a types of scriptPubkey descriptors in which given extended public/private keys can be used. Returns None if the version is not recognized/unknown to the resolver.

pub fn derivation_path<R: VersionResolver>(
    &self,
    account: Option<ChildNumber>
) -> Option<DerivationPath>

Returns BIP 32 derivation path for the provided key version. Returns None if the version is not recognized/unknown to the resolver.

pub fn try_to_pub<R: VersionResolver>(&self) -> Option<KeyVersion>

Converts version into version corresponding to an extended public key. Returns None if the resolver does not know how to perform conversion.

pub fn try_to_prv<R: VersionResolver>(&self) -> Option<KeyVersion>

Converts version into version corresponding to an extended private key. Returns None if the resolver does not know how to perform conversion.

impl KeyVersion

pub fn from_slice(version_slice: &[u8]) -> Option<KeyVersion>

Tries to construct KeyVersion object from a byte slice. If byte slice length is not equal to 4, returns None

pub fn from_xkey_str(key: &str) -> Result<KeyVersion, Error>

Constructs KeyVersion from a Base58-encoded extended key string.

Panics

If the string does not contain at least 5 characters.

pub fn from_bytes(version_bytes: [u8; 4]) -> KeyVersion

Constructs KeyVersion from a fixed 4 bytes values

pub fn from_u32(version: u32) -> KeyVersion

Constructs KeyVersion from a u32-representation of the version bytes (the representation must be in bing endian format)

pub fn to_u32(&self) -> u32

Converts version bytes into u32 representation in big endian format

pub fn as_slice(&self) -> &[u8]

Returns slice representing internal version bytes

pub fn as_bytes(&self) -> &[u8; 4]

Returns internal representation of version bytes

pub fn to_bytes(&self) -> [u8; 4]

Constructs 4-byte array containing version byte values

pub fn into_bytes(self) -> [u8; 4]

Converts into 4-byte array containing version byte values

Trait Implementations

impl Clone for KeyVersion

fn clone(&self) -> KeyVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyVersion

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

Formats the value using the given formatter.

impl Hash for KeyVersion

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for KeyVersion

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeyVersion> for KeyVersion

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

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

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

This method tests for !=.

impl PartialOrd<KeyVersion> for KeyVersion

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

impl Eq for KeyVersion

impl StructuralEq for KeyVersion

impl StructuralPartialEq for KeyVersion