Struct jubjub::Fq

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus). Read more

source

fn to_repr(&self) -> <Scalar as PrimeField>::Repr

Converts an element of the prime field into the standard byte representation for this field. Read more

source

fn is_odd(&self) -> Choice

Returns true iff this element is odd.

source

const NUM_BITS: u32 = 255u32

How many bits are needed to represent an element of this field.

source

const CAPACITY: u32 = 254u32

How many bits of information can be reliably stored in the field element. Read more

source

fn multiplicative_generator() -> Scalar

Returns a fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue. Read more

source

const S: u32 = 32u32

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd. Read more

source

fn root_of_unity() -> Scalar

Returns the 2^s root of unity. Read more

source

fn from_str_vartime(s: &str) -> Option<Self>

Interpret a string of numbers as a (congruent) prime field element. Does not accept unnecessary leading zeroes or a blank string. Read more

source

fn from_repr_vartime(repr: Self::Repr) -> Option<Self>

Attempts to convert a byte representation of a field element into an element of this prime field, failing if the input is not canonical (is not smaller than the field’s modulus). Read more

source

fn is_even(&self) -> Choice

Returns true iff this element is even.

source

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

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, rhs: &'b Scalar) -> Scalar

Performs the - operation. Read more

source

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

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, rhs: &'b Scalar) -> Scalar

Performs the - operation. Read more

source

impl Sub<Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, rhs: Scalar) -> Scalar

Performs the - operation. Read more

source

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

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, rhs: Scalar) -> Scalar

Performs the - operation. Read more

source

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

source

fn sub_assign(&mut self, rhs: &'b Scalar)

Performs the -= operation. Read more

source

impl SubAssign<Scalar> for Scalar

source

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation. Read more

source

impl<T> Sum<T> for Scalar where
T: Borrow<Scalar>,

source

fn sum(iter: I) -> Scalar where
I: Iterator<Item = T>,

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

source

impl Copy for Scalar

source

impl Eq for Scalar

source

impl StructuralEq for Scalar

Auto Trait Implementations

impl RefUnwindSafe for Scalar

impl Send for Scalar

impl Sync for Scalar

impl Unpin for Scalar

impl UnwindSafe for Scalar

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> ConditionallyNegatable for T where
 T: ConditionallySelectable,
 &'a T: for<'a> Neg,
 <&'a T as Neg>::Output == T,

source

fn conditional_negate(&mut self, choice: Choice)

Negate self if choice == Choice(1); otherwise, leave it unchanged. Read more

impl<T> Conv for T

fn conv<T>(self) -> T where
Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

Causes self to use its Binary implementation when Debug-formatted. Read more

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

Causes self to use its Display implementation when Debug-formatted. Read more

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted. Read more

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted. Read more

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

Causes self to use its Octal implementation when Debug-formatted. Read more

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted. Read more

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted. Read more

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted. Read more

fn fmt_list(self) -> FmtList<Self> where
&'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
 Self: Borrow,
 B: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut B) -> R
) -> R where
 Self: BorrowMut,
 B: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
 Self: AsRef,
 U: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
 Self: AsMut,
 U: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
 Self: Deref<Target = T>,
 T: 'a + ?Sized,
 R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>(
 &'a mut self,
 func: impl FnOnce(&'a mut T) -> R
) -> R where
 Self: DerefMut<Target = T> + Deref,
 T: 'a + ?Sized,
 R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow,
B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut,
B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

source

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

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)

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

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

source

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

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, Rhs, Output> GroupOps<Rhs, Output> for T where
T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,

source

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T where
T: for<'r> GroupOps<&'r Rhs, Output>,

source

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T where
T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,

source

Struct jubjub::Fq

Implementations

impl Scalar

pub const fn zero() -> Scalar

pub const fn one() -> Scalar

pub const fn double(&self) -> Scalar

pub fn from_bytes(bytes: &[u8; 32]) -> CtOption<Scalar>

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

pub fn from_bytes_wide(bytes: &[u8; 64]) -> Scalar

pub const fn from_raw(val: [u64; 4]) -> Scalar

pub const fn square(&self) -> Scalar

pub fn sqrt(&self) -> CtOption<Scalar>

pub fn pow(&self, by: &[u64; 4]) -> Scalar

pub fn pow_vartime(&self, by: &[u64; 4]) -> Scalar

pub fn invert(&self) -> CtOption<Scalar>

pub const fn mul(&self, rhs: &Scalar) -> Scalar

pub const fn sub(&self, rhs: &Scalar) -> Scalar

pub const fn add(&self, rhs: &Scalar) -> Scalar

pub const fn neg(&self) -> Scalar

Trait Implementations

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

type Output = Scalar

fn add(self, rhs: &'b Scalar) -> Scalar

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

type Output = Scalar

fn add(self, rhs: &'b Scalar) -> Scalar

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

type Output = Scalar

fn add(self, rhs: Scalar) -> Scalar

impl Add<Scalar> for Scalar

type Output = Scalar

fn add(self, rhs: Scalar) -> Scalar

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

fn add_assign(&mut self, rhs: &'b Scalar)

impl AddAssign<Scalar> for Scalar

fn add_assign(&mut self, rhs: Scalar)

impl Clone for Scalar

fn clone(&self) -> Scalar

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

impl ConditionallySelectable for Scalar

fn conditional_select(a: &Scalar, b: &Scalar, choice: Choice) -> Scalar

fn conditional_assign(&mut self, other: &Self, choice: Choice)

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

impl ConstantTimeEq for Scalar

fn ct_eq(&self, other: &Scalar) -> Choice

impl Debug for Scalar

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

impl Default for Scalar

fn default() -> Scalar

impl Display for Scalar

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

impl Field for Scalar

fn random(rng: impl RngCore) -> Scalar

fn zero() -> Scalar

fn one() -> Scalar

fn square(&self) -> Scalar

fn double(&self) -> Scalar

fn invert(&self) -> CtOption<Scalar>

fn sqrt(&self) -> CtOption<Scalar>

fn is_zero(&self) -> Choice

fn is_zero_vartime(&self) -> bool

fn cube(&self) -> Self

fn pow_vartime<S>(&self, exp: S) -> Self where S: AsRef<[u64]>,

impl From<u64> for Scalar

fn from(val: u64) -> Scalar

impl<'a, 'b> Mul<&'b Scalar> for &'a Scalar

type Output = Scalar

fn mul(self, rhs: &'b Scalar) -> Scalar

impl<'b> Mul<&'b Scalar> for Scalar

type Output = Scalar

fn mul(self, rhs: &'b Scalar) -> Scalar

impl<'a> Mul<Scalar> for &'a Scalar

type Output = Scalar

fn mul(self, rhs: Scalar) -> Scalar

impl Mul<Scalar> for Scalar

type Output = Scalar

fn mul(self, rhs: Scalar) -> Scalar

impl<'b> MulAssign<&'b Scalar> for Scalar

fn mul_assign(&mut self, rhs: &'b Scalar)

impl MulAssign<Scalar> for Scalar

pub fn from_bytes(bytes: &[u8 ; 32]) -> CtOption<Scalar>

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

pub fn from_bytes_wide(bytes: &[u8 ; 64]) -> Scalar

pub const fn from_raw(val: [u64 ; 4]) -> Scalar

pub fn pow(&self, by: &[u64 ; 4]) -> Scalar

pub fn pow_vartime(&self, by: &[u64 ; 4]) -> Scalar

fn pow_vartime<S>(&self, exp: S) -> Self where
S: AsRef<[u64 ]>,

type Repr = [u8 ; 32]

impl<T> Sum<T> for Scalar where
T: Borrow<Scalar>,

fn sum<I>(iter: I) -> Scalar where
I: Iterator<Item = T>,

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

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

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

impl<T> ConditionallyNegatable for T where
T: ConditionallySelectable,
&'a T: for<'a> Neg,
<&'a T as Neg>::Output == T,

fn conv<T>(self) -> T where
Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,