Enum PublicKey 

pub enum PublicKey {
    Ed25519(PublicKey),
    Bls(PublicKey),
    BlsShare(PublicKeyShare),
}

Wrapper for different public key types.

Variants

Ed25519(PublicKey)

Ed25519 public key.

Bls(PublicKey)

BLS public key.

BlsShare(PublicKeyShare)

BLS public key share.

Implementations

impl PublicKey

pub fn ed25519_from_hex(hex: &str) -> Result<PublicKey, Error>

Construct and ed25519 public key from a hex-encoded string.

It is often useful to parse such raw strings in user-facing apps like CLI.

pub fn bls_from_hex(hex: &str) -> Result<PublicKey, Error>

Construct a BLS public key from a hex-encoded string.

It is often useful to parse such raw strings in user-facing apps like CLI.

pub fn to_bytes(self) -> Vec<u8>

Returns the bytes of the underlying public key.

pub fn ed25519(&self) -> Option<PublicKey>

Returns the ed25519 key, if applicable.

pub fn bls(&self) -> Option<PublicKey>

Returns the BLS key, if applicable.

pub fn bls_share(&self) -> Option<PublicKeyShare>

Returns the BLS key share, if applicable.

pub fn verify<T>(&self, signature: &Signature, data: T) -> Result<(), Error>

where T: AsRef<[u8]>,

Returns Ok(()) if signature matches the message and Err(Error::InvalidSignature) otherwise.

pub fn encode_to_zbase32(&self) -> Result<String, Error>

Returns the PublicKey serialised and encoded in z-base-32.

pub fn decode_from_zbase32<I>(encoded: I) -> Result<PublicKey, Error>

where I: AsRef<str>,

Creates from z-base-32 encoded string.

pub fn fmt_ed25519(pk: &PublicKey, f: &mut Formatter<'_>) -> Result<(), Error>

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

fn deserialize<__D>( __deserializer: __D, ) -> Result<PublicKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PublicKey

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

Formats the value using the given formatter.

impl From<&Keypair> for PublicKey

fn from(keypair: &Keypair) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for PublicKey

fn from(public_key: PublicKey) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for PublicKey

fn from(public_key: PublicKey) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for XorName

fn from(public_key: PublicKey) -> XorName

Converts to this type from the input type.

impl From<PublicKeyShare> for PublicKey

fn from(public_key: PublicKeyShare) -> PublicKey

Converts to this type from the input type.

impl Hash for PublicKey

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for PublicKey

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

Useful for displaying public key in user-facing apps E.g. in cli and in human-readable messaging like for sn_authd

impl Ord for PublicKey

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PublicKey

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

fn partial_cmp(&self, other: &PublicKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PublicKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for PublicKey

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

Useful for displaying public key in user-facing apps E.g. in cli and in human-readable messaging like for sn_authd

impl Copy for PublicKey

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey