KeyType

Enum KeyType 

Source
pub enum KeyType {
    Private,
    Public,
}
Expand description

Key type identifier for extended keys.

BIP32 defines two types of extended keys:

  • Private extended keys (xprv/tprv) - contain private key material
  • Public extended keys (xpub/tpub) - contain only public key material

§Examples

use khodpay_bip32::KeyType;

let private = KeyType::Private;
let public = KeyType::Public;

assert!(private.is_private());
assert!(public.is_public());

Variants§

§

Private

Private extended key (xprv/tprv).

Contains private key material and can be used to:

  • Derive child private keys
  • Derive child public keys
  • Sign transactions
§

Public

Public extended key (xpub/tpub).

Contains only public key material and can be used to:

  • Derive child public keys (normal derivation only)
  • Verify signatures
  • Generate addresses for watching

Cannot:

  • Derive hardened child keys
  • Sign transactions

Implementations§

Source§

impl KeyType

Source

pub fn is_private(&self) -> bool

Returns true if this is a private key type.

§Examples
use khodpay_bip32::KeyType;

assert!(KeyType::Private.is_private());
assert!(!KeyType::Public.is_private());
Source

pub fn is_public(&self) -> bool

Returns true if this is a public key type.

§Examples
use khodpay_bip32::KeyType;

assert!(KeyType::Public.is_public());
assert!(!KeyType::Private.is_public());
Source

pub fn name(&self) -> &'static str

Returns the human-readable name of the key type.

§Examples
use khodpay_bip32::KeyType;

assert_eq!(KeyType::Private.name(), "Private");
assert_eq!(KeyType::Public.name(), "Public");

Trait Implementations§

Source§

impl Clone for KeyType

Source§

fn clone(&self) -> KeyType

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for KeyType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for KeyType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for KeyType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for KeyType

Source§

impl Eq for KeyType

Source§

impl StructuralPartialEq for KeyType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V