Struct MontScalar 

#[repr(transparent)]
pub struct MontScalar<T: MontConfig<4>>(pub Fp256<MontBackend<T, 4>>);

A wrapper struct around a Fp256<MontBackend<T, 4>> that can easily implement the Scalar trait.

Using the Scalar trait rather than this type is encouraged to allow for easier switching of the underlying field.

Tuple Fields

0: Fp256<MontBackend<T, 4>>

Implementations

impl<T: MontConfig<4>> MontScalar<T>

pub fn from_bigint(vals: [u64; 4]) -> Self

Create a new MontScalar<T> from a [u64, 4]. The array is expected to be in non-montgomery form.

Panics

This method will panic if the provided [u64; 4] cannot be converted into a valid BigInt due to an overflow or invalid input. The method unwraps the result of Fp::from_bigint, which will panic if the BigInt does not represent a valid field element (“Invalid input” refers to an integer that is outside the valid range [0,p-1] for the prime field or cannot be represented as a canonical field element. It can also occur due to overflow or issues in the conversion process.).

pub fn from_le_bytes_mod_order(bytes: &[u8]) -> Self

Create a new MontScalar<T> from a [u8] modulus the field order. The array is expected to be in non-montgomery form.

pub fn to_bytes_le(&self) -> Vec<u8>

Create a Vec<u8> from a MontScalar<T>. The array will be in non-montgomery form.

Trait Implementations

impl<T: MontConfig<4>> Add for MontScalar<T>

type Output = MontScalar<T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T: MontConfig<4>> AddAssign for MontScalar<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: MontConfig<4>> CanonicalDeserialize for MontScalar<T>

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<T: MontConfig<4>> CanonicalSerialize for MontScalar<T>

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

The general serialize method that takes in customization flags.

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

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<T: MontConfig<4>> Clone for MontScalar<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: MontConfig<4>> Debug for MontScalar<T>

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

Formats the value using the given formatter.

impl<T: MontConfig<4>> Default for MontScalar<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: MontConfig<4>> Deserialize<'de> for MontScalar<T>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: MontConfig<4>> Display for MontScalar<T>

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

Formats the value using the given formatter.

impl<T: MontConfig<4>> From<&[u8]> for MontScalar<T>

Implement From<&[u8]> for MontScalar

fn from(x: &[u8]) -> Self

Converts to this type from the input type.

impl From<&MontScalar<FrConfig>> for Scalar

fn from(value: &Curve25519Scalar) -> Self

Panics

This method will panic if the byte array is not of the expected length (32 bytes) or if it cannot be converted to a valid canonical scalar. However, under normal conditions, valid Curve25519Scalar values should always satisfy these requirements.

impl<T: MontConfig<4>> From<&MontScalar<T>> for [u64; 4]

fn from(value: &MontScalar<T>) -> Self

Converts to this type from the input type.

impl<F: MontConfig<4>, T> From<&T> for MontScalar<F>

where T: Into<MontScalar<F>> + Clone,

fn from(x: &T) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<&str> for MontScalar<T>

fn from(x: &str) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<[u64; 4]> for MontScalar<T>

fn from(value: [u64; 4]) -> Self

Converts to this type from the input type.

impl From<MontScalar<FrConfig>> for Scalar

fn from(value: Curve25519Scalar) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<MontScalar<T>> for [u64; 4]

fn from(value: MontScalar<T>) -> Self

Converts to this type from the input type.

impl<T> From<MontScalar<T>> for BigInt

where T: MontConfig<4>, MontScalar<T>: Scalar,

fn from(value: MontScalar<T>) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<String> for MontScalar<T>

fn from(x: String) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<bool> for MontScalar<T>

fn from(x: bool) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<i128> for MontScalar<T>

fn from(x: i128) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<i16> for MontScalar<T>

fn from(x: i16) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<i32> for MontScalar<T>

fn from(x: i32) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<i64> for MontScalar<T>

fn from(x: i64) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<i8> for MontScalar<T>

fn from(x: i8) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<u128> for MontScalar<T>

fn from(x: u128) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<u16> for MontScalar<T>

fn from(x: u16) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<u32> for MontScalar<T>

fn from(x: u32) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<u64> for MontScalar<T>

fn from(x: u64) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> From<u8> for MontScalar<T>

fn from(x: u8) -> Self

Converts to this type from the input type.

impl<T: MontConfig<4>> Hash for MontScalar<T>

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<T: MontConfig<4>> Inv for MontScalar<T>

type Output = Option<MontScalar<T>>

The result after applying the operator.

fn inv(self) -> Option<Self>

Returns the multiplicative inverse of self.

impl Mul<MontScalar<FrConfig>> for &RistrettoPoint

type Output = RistrettoPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Curve25519Scalar) -> Self::Output

Performs the * operation.

impl Mul<MontScalar<FrConfig>> for RistrettoPoint

type Output = RistrettoPoint

The resulting type after applying the * operator.

fn mul(self, rhs: Curve25519Scalar) -> Self::Output

Performs the * operation.

impl<T: MontConfig<4>> Mul for MontScalar<T>

type Output = MontScalar<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T: MontConfig<4>> MulAssign for MontScalar<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: MontConfig<4>> Neg for &MontScalar<T>

type Output = MontScalar<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: MontConfig<4>> Neg for MontScalar<T>

type Output = MontScalar<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: MontConfig<4>> One for MontScalar<T>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<T: MontConfig<4>> Ord for MontScalar<T>

fn cmp(&self, other: &Self) -> 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<T: MontConfig<4>> PartialEq for MontScalar<T>

fn eq(&self, other: &Self) -> 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<T: MontConfig<4>> PartialOrd for MontScalar<T>

fn partial_cmp(&self, other: &Self) -> 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<T: MontConfig<4>> Product for MontScalar<T>

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

Takes an iterator and generates Self from the elements by multiplying the items.

impl<T> Scalar for MontScalar<T>

where T: MontConfig<4>,

const MAX_SIGNED: Self

The value (p - 1) / 2. This is “mid-point” of the field - the “six” on the clock. It is the largest signed value that can be represented in the field with the natural embedding.

const ZERO: Self

The 0 (additive identity) element of the field.

const ONE: Self

The 1 (multiplicative identity) element of the field.

const TWO: Self

1 + 1

const TEN: Self

2 + 2 + 2 + 2 + 2

const TWO_POW_64: Self

2^64

const CHALLENGE_MASK: U256

The value to mask the challenge with to ensure it is in the field. This one less than the largest power of 2 that is less than the field modulus.

const MAX_BITS: u8

The largest n such that 2^n <=p

const MAX_SIGNED_U256: U256

A U256 representation of the largest signed value in the field.

impl<T: MontConfig<4>> Serialize for MontScalar<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: MontConfig<4>> Sub for MontScalar<T>

type Output = MontScalar<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: MontConfig<4>> SubAssign for MontScalar<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a, T: MontConfig<4>> Sum<&'a MontScalar<T>> for MontScalar<T>

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<T: MontConfig<4>> Sum for MontScalar<T>

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

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

impl<T: MontConfig<4>> TransparentWrapper<Fp<MontBackend<T, 4>, 4>> for MontScalar<T>

fn wrap(s: Inner) -> Self

where Self: Sized,

Convert the inner type into the wrapper type.

fn wrap_ref(s: &Inner) -> &Self

Convert a reference to the inner type into a reference to the wrapper type.

fn wrap_mut(s: &mut Inner) -> &mut Self

Convert a mutable reference to the inner type into a mutable reference to the wrapper type.

fn wrap_slice(s: &[Inner]) -> &[Self]

where Self: Sized,

Convert a slice to the inner type into a slice to the wrapper type.

fn wrap_slice_mut(s: &mut [Inner]) -> &mut [Self]

where Self: Sized,

Convert a mutable slice to the inner type into a mutable slice to the wrapper type.

fn peel(s: Self) -> Inner

where Self: Sized,

Convert the wrapper type into the inner type.

fn peel_ref(s: &Self) -> &Inner

Convert a reference to the wrapper type into a reference to the inner type.

fn peel_mut(s: &mut Self) -> &mut Inner

Convert a mutable reference to the wrapper type into a mutable reference to the inner type.

fn peel_slice(s: &[Self]) -> &[Inner]

where Self: Sized,

Convert a slice to the wrapped type into a slice to the inner type.

fn peel_slice_mut(s: &mut [Self]) -> &mut [Inner]

where Self: Sized,

Convert a mutable slice to the wrapped type into a mutable slice to the inner type.

impl<T> TryFrom<BigInt> for MontScalar<T>

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: BigInt) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for bool

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for i128

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for i16

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for i32

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for i64

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for i8

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<MontScalar<T>> for u8

where T: MontConfig<4>, MontScalar<T>: Scalar,

type Error = ScalarConversionError

The type returned in the event of a conversion error.

fn try_from(value: MontScalar<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: MontConfig<4>> UniformRand for MontScalar<T>

fn rand<R: Rng + ?Sized>(rng: &mut R) -> Self

impl<T: MontConfig<4>> Valid for MontScalar<T>

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

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

where Self: 'a,

impl<T: MontConfig<4>> Zero for MontScalar<T>

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<T: MontConfig<4>> Copy for MontScalar<T>

impl<T: MontConfig<4>> Eq for MontScalar<T>