Struct PublicKey

pub struct PublicKey { /* private fields */ }

Represents a public key for both the client and server.

This is used instead of a raw array in order to move the error of verifying the key out of the proof functions in order to increase readability.

Will return an error if all elements are 0, or the bytes represented as an integer modulus the large safe prime is equal to 0. Since the large safe prime multiplied by 2 results in a 33 byte value it is unrepresentable as a public key and thus the only two failure opportunities are if the key is exactly zero or if it is exactly equal to the large safe prime.

Implementations

impl PublicKey

pub const fn as_le_bytes(&self) -> &[u8; 32]

Returns the value as little endian bytes.

The bytes are stored internally as little endian, so this causes no reversal.

impl PublicKey

pub fn from_le_bytes(key: [u8; 32]) -> Result<Self, InvalidPublicKeyError>

Creates the struct from little endian bytes.

Values are stored internally as little endian so no reversal occurs.

Errors

Will error if the public key is invalid. See PublicKey for specifics.

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy 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

Formats the value using the given formatter.

impl Hash for PublicKey

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 Copy for PublicKey

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey