Struct Element

pub struct Element { /* private fields */ }

Implementations

impl Element

pub const GENERATOR: Self = _

Return the conventional generator for decaf377.

pub const IDENTITY: Self = _

impl Element

pub fn is_identity(&self) -> bool

Convenience method to make identity checks more readable.

pub fn vartime_multiscalar_mul<I, J>(scalars: I, points: J) -> Element

where I: IntoIterator, I::Item: Borrow<Fr>, J: IntoIterator, J::Item: Borrow<Element>,

Given an iterator of public scalars and an iterator of public points, compute $$ Q = [c_1] P_1 + \cdots + [c_n] P_n, $$ using variable-time operations.

It is an error to call this function with two iterators of different lengths – it would require ExactSizeIterator, but ExactSizeIterators are not closed under chaining, and disallowing iterator chaining would destroy the utility of the function.

impl Element

pub fn hash_to_curve(r_1: &Fq, r_2: &Fq) -> Element

Maps two field elements to a uniformly distributed decaf377 Element.

The two field elements provided as inputs should be independently chosen.

pub fn encode_to_curve(r: &Fq) -> Element

Maps a field element to a decaf377 Element suitable for CDH challenges.

impl Element

pub fn negate(&self) -> Element

pub fn vartime_compress_to_field(&self) -> Fq

pub fn vartime_compress(&self) -> Encoding

Trait Implementations

impl<'a, 'b> Add<&'b Element> for &'a Element

type Output = Element

The resulting type after applying the + operator.

fn add(self, other: &'b Element) -> Element

Performs the + operation.

impl<'b> Add<&'b Element> for Element

type Output = Element

The resulting type after applying the + operator.

fn add(self, other: &'b Element) -> Element

Performs the + operation.

impl<'a> Add<Element> for &'a Element

type Output = Element

The resulting type after applying the + operator.

fn add(self, other: Element) -> Element

Performs the + operation.

impl Add<Element> for ElementVar

type Output = ElementVar

The resulting type after applying the + operator.

fn add(self, other: Element) -> Self::Output

Performs the + operation.

impl Add for Element

type Output = Element

The resulting type after applying the + operator.

fn add(self, other: Element) -> Element

Performs the + operation.

impl<'b> AddAssign<&'b Element> for Element

fn add_assign(&mut self, other: &'b Element)

Performs the += operation.

impl AddAssign<Element> for ElementVar

fn add_assign(&mut self, rhs: Element)

Performs the += operation.

impl AddAssign for Element

fn add_assign(&mut self, other: Element)

Performs the += operation.

impl CanonicalDeserialize for Element

fn deserialize_with_mode<R: Read>( reader: R, compress: Compress, validate: Validate, ) -> Result<Self, SerializationError>

The general deserialize method that takes in customization flags.

fn deserialize_compressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

fn deserialize_compressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

fn deserialize_uncompressed<R>(reader: R) -> Result<Self, SerializationError>

where R: Read,

fn deserialize_uncompressed_unchecked<R>( reader: R, ) -> Result<Self, SerializationError>

where R: Read,

impl CanonicalSerialize for Element

fn serialized_size(&self, compress: Compress) -> usize

fn serialize_with_mode<W: Write>( &self, writer: W, mode: Compress, ) -> Result<(), SerializationError>

The general serialize method that takes in customization flags.

fn serialize_compressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

fn compressed_size(&self) -> usize

fn serialize_uncompressed<W>(&self, writer: W) -> Result<(), SerializationError>

where W: Write,

fn uncompressed_size(&self) -> usize

impl Clone for Element

fn clone(&self) -> Element

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CurveGroup for Element

type Config = Decaf377EdwardsConfig

type BaseField = Fq

The field over which this curve is defined.

type Affine = AffinePoint

The affine representation of this element.

type FullGroup = AffinePoint

Type representing an element of the full elliptic curve group, not just the prime order subgroup.

fn normalize_batch(v: &[Self]) -> Vec<AffinePoint>

Normalizes a slice of group elements into affine.

fn into_affine(self) -> Self::Affine

Converts self into the affine representation.

impl Debug for Element

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

Formats the value using the given formatter.

impl Default for Element

fn default() -> Self

Returns the “default value” for a type.

impl Display for Element

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

Formats the value using the given formatter.

impl Distribution<Element> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Element

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<&Element> for Encoding

fn from(point: &Element) -> Self

Converts to this type from the input type.

impl From<Element> for [u8; 32]

fn from(enc: Element) -> [u8; 32]

Converts to this type from the input type.

impl From<Element> for Encoding

fn from(point: Element) -> Self

Converts to this type from the input type.

impl Group for Element

type ScalarField = Fr

The scalar field F_r, where r is the order of this group.

fn double_in_place(&mut self) -> &mut Self

Double self in place.

fn generator() -> Self

Returns a fixed generator of this group.

fn mul_bigint(&self, other: impl AsRef<[u64]>) -> Self

Performs scalar multiplication of this element.

fn double(&self) -> Self

Doubles self.

fn mul_bits_be(&self, other: impl Iterator<Item = bool>) -> Self

Computes other * self, where other is a big-endian bit representation of some integer.

impl Hash for Element

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<'a, 'b> Mul<&'b Element> for &'a Fr

type Output = Element

The resulting type after applying the * operator.

fn mul(self, point: &'b Element) -> Element

Performs the * operation.

impl<'b> Mul<&'b Element> for Fr

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: &'b Element) -> Element

Performs the * operation.

impl<'a, 'b> Mul<&'b Fr> for &'a Element

type Output = Element

The resulting type after applying the * operator.

fn mul(self, point: &'b Fr) -> Element

Performs the * operation.

impl<'b> Mul<&'b Fr> for Element

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: &'b Fr) -> Element

Performs the * operation.

impl<'a> Mul<Element> for &'a Fr

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: Element) -> Element

Performs the * operation.

impl Mul<Element> for Fr

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: Element) -> Element

Performs the * operation.

impl<'a> Mul<Fr> for &'a Element

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: Fr) -> Element

Performs the * operation.

impl Mul<Fr> for Element

type Output = Element

The resulting type after applying the * operator.

fn mul(self, other: Fr) -> Element

Performs the * operation.

impl<'b> MulAssign<&'b Fr> for Element

fn mul_assign(&mut self, point: &'b Fr)

Performs the *= operation.

impl MulAssign<Fr> for Element

fn mul_assign(&mut self, other: Fr)

Performs the *= operation.

impl Neg for Element

type Output = Element

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Element

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

const NEGATION_IS_CHEAP: bool = true

type MulBase = AffinePoint

fn batch_convert_to_mul_base(bases: &[Self]) -> Vec<Self::MulBase>

impl<'a, 'b> Sub<&'b Element> for &'a Element

type Output = Element

The resulting type after applying the - operator.

fn sub(self, other: &'b Element) -> Element

Performs the - operation.

impl<'b> Sub<&'b Element> for Element

type Output = Element

The resulting type after applying the - operator.

fn sub(self, other: &'b Element) -> Element

Performs the - operation.

impl<'a> Sub<Element> for &'a Element

type Output = Element

The resulting type after applying the - operator.

fn sub(self, other: Element) -> Element

Performs the - operation.

impl Sub<Element> for ElementVar

type Output = ElementVar

The resulting type after applying the - operator.

fn sub(self, other: Element) -> Self::Output

Performs the - operation.

impl Sub for Element

type Output = Element

The resulting type after applying the - operator.

fn sub(self, other: Element) -> Element

Performs the - operation.

impl<'b> SubAssign<&'b Element> for Element

fn sub_assign(&mut self, other: &'b Element)

Performs the -= operation.

impl SubAssign<Element> for ElementVar

fn sub_assign(&mut self, rhs: Element)

Performs the -= operation.

impl SubAssign for Element

fn sub_assign(&mut self, other: Element)

Performs the -= operation.

impl<'a> Sum<&'a Element> for Element

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Element

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<&[u8]> for Element

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Encoding> for Element

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(bytes: &Encoding) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 32]> for Element

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(bytes: [u8; 32]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Encoding> for Element

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(bytes: Encoding) -> Result<Self, Self::Error>

Performs the conversion.

impl Valid for Element

fn check(&self) -> Result<(), SerializationError>

fn batch_check<'a>( batch: impl Iterator<Item = &'a Self> + Send, ) -> Result<(), SerializationError>

where Self: 'a,

impl VariableBaseMSM for Element

fn msm_unchecked(bases: &[Self::MulBase], scalars: &[Self::ScalarField]) -> Self

Computes an inner product between the PrimeField elements in scalars and the corresponding group elements in bases.

fn msm( bases: &[Self::MulBase], scalars: &[Self::ScalarField], ) -> Result<Self, usize>

Performs multi-scalar multiplication, without checking that bases.len() == scalars.len().

fn msm_bigint( bases: &[Self::MulBase], bigints: &[<Self::ScalarField as PrimeField>::BigInt], ) -> Self

Optimized implementation of multi-scalar multiplication.

fn msm_chunks<I, J>(bases_stream: &J, scalars_stream: &I) -> Self

where I: Iterable + ?Sized, <I as Iterable>::Item: Borrow<Self::ScalarField>, J: Iterable, <J as Iterable>::Item: Borrow<Self::MulBase>,

Streaming multi-scalar multiplication algorithm with hard-coded chunk size.

impl Zero for Element

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zeroize for Element

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Copy for Element

impl Eq for Element

impl<'a> GroupOpsBounds<'a, Element, ElementVar> for ElementVar