Struct bip32::Prefix

#[non_exhaustive]
pub struct Prefix { /* private fields */ }

BIP32 extended key prefixes a.k.a. “versions” (e.g. xpub, xprv)

The BIP32 spec describes these as “versions” and gives examples for xprv/xpub (mainnet) and tprv/tpub (testnet), however in practice there are many more used (e.g. ypub, zpub).

Implementations

impl Prefix

pub const LENGTH: usize = 4usize

Length of a prefix in ASCII characters.

pub const TPRV: Self = _

tprv prefix

pub const TPUB: Self = _

tpub prefix

pub const XPRV: Self = _

xprv prefix

pub const XPUB: Self = _

xpub prefix

pub const YPRV: Self = _

yprv prefix

pub const YPUB: Self = _

ypub prefix

pub const ZPRV: Self = _

zprv prefix

pub const ZPUB: Self = _

zpub prefix

pub const fn from_parts_unchecked(s: &str, version: Version) -> Self

Create a new prefix from the given 4-character string and version number. The main intended use case for this function is Prefix constants such as Prefix::XPRV.

Warning

Use this function with care: No consistency check is performed! It is up to the caller to ensure that the version number matches the prefix.

Panics

Panics if s is not 4 chars long, or any of the chars lie outside of the supported range: lower case (a..=z) or upper case (A..=Z) letters.

pub fn from_bytes(bytes: [u8; 4]) -> Result<Self>

Create a new prefix from the given encoded bytes.

These bytes represent the big endian serialization of a Version integer.

pub fn as_str(&self) -> &str

Get the prefix as a string.

pub fn is_public(self) -> bool

Is this a public key?

pub fn is_private(self) -> bool

Is this a private key?

pub fn version(self) -> Version

Get the Version number.

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

Serialize the Version number as big-endian bytes.

Trait Implementations

impl AsRef<str> for Prefix

fn as_ref(&self) -> &str

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

impl Clone for Prefix

fn clone(&self) -> Prefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Prefix

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

Formats the value using the given formatter.

impl Display for Prefix

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

Formats the value using the given formatter.

impl From<&Prefix> for Version

fn from(prefix: &Prefix) -> Version

Converts to this type from the input type.

impl From<Prefix> for Version

fn from(prefix: Prefix) -> Version

Converts to this type from the input type.

impl Ord for Prefix

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

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

fn partial_cmp(&self, other: &Prefix) -> 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 TryFrom<&[u8]> for Prefix

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Prefix>

Performs the conversion.

impl TryFrom<u32> for Prefix

type Error = Error

The type returned in the event of a conversion error.

fn try_from(version: Version) -> Result<Self>

Performs the conversion.

impl Copy for Prefix

impl Eq for Prefix

impl StructuralEq for Prefix

impl StructuralPartialEq for Prefix