Struct schnorrkel::points::RistrettoBoth

pub struct RistrettoBoth { /* fields omitted */ }

A RistrettoBoth contains both an uncompressed RistrettoPoint as well as the corresponding CompressedRistretto. It provides a convenient middle ground for protocols that both hash compressed points to derive scalars for use with uncompressed points.

Methods

impl RistrettoBoth

pub fn as_compressed(&self) -> &CompressedRistretto

Access the compressed Ristretto form

pub fn into_compressed(self) -> CompressedRistretto

Extract the compressed Ristretto form

pub fn as_point(&self) -> &RistrettoPoint

Access the point form

pub fn into_point(self) -> RistrettoPoint

Extract the point form

pub fn from_compressed(
    compressed: CompressedRistretto
) -> SignatureResult<RistrettoBoth>

Decompress into the RistrettoBoth format that also retains the compressed form.

pub fn from_point(point: RistrettoPoint) -> RistrettoBoth

Compress into the RistrettoBoth format that also retains the uncompressed form.

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

Convert this public key to a byte array.

pub fn from_bytes(bytes: &[u8]) -> SignatureResult<RistrettoBoth>

Construct a RistrettoBoth from a slice of bytes.

Warning

The caller is responsible for ensuring that the bytes passed into this method actually represent a curve25519_dalek::ristretto::CompressedRistretto and that said compressed point is actually a point on the curve.

Example

use schnorrkel::points::RistrettoBoth;
use schnorrkel::PUBLIC_KEY_LENGTH;
use schnorrkel::SignatureError;

let public_key_bytes: [u8; PUBLIC_KEY_LENGTH] = [
   215,  90, 152,   1, 130, 177,  10, 183, 213,  75, 254, 211, 201, 100,   7,  58,
    14, 225, 114, 243, 218, 166,  35,  37, 175,   2,  26, 104, 247,   7,   81, 26];

let public_key = RistrettoBoth::from_bytes(&public_key_bytes)?;

Returns

A Result whose okay value is an EdDSA RistrettoBoth or whose error value is an SignatureError describing the error that occurred.

pub fn from_bytes_ser(
    name: &'static str,
    description: &'static str,
    bytes: &[u8]
) -> SignatureResult<RistrettoBoth>

Variant of RistrettoBoth::from_bytes that propogates more informative errors.

Trait Implementations

impl PartialEq<RistrettoBoth> for RistrettoBoth

We hide fields largely so that only compairing the compressed forms works.

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

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

#[must_use]

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

This method tests for !=.

impl Eq for RistrettoBoth

impl Ord for RistrettoBoth

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<RistrettoBoth> for RistrettoBoth

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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 Hash for RistrettoBoth

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

impl Debug for RistrettoBoth

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

Formats the value using the given formatter.

impl Clone for RistrettoBoth

fn clone(&self) -> RistrettoBoth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RistrettoBoth

fn default() -> RistrettoBoth

Returns the "default value" for a type.