Struct Bls12_381Scalar

pub struct Bls12_381Scalar(/* private fields */);

Scalar field element of BLS12-381 Internal: Four 64-bit limbs in little-endian Montgomery form

Implementations

impl Scalar

pub const fn zero() -> Scalar

Additive identity

pub const fn one() -> Scalar

Multiplicative identity

pub const fn double(&self) -> Scalar

Double this element

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

Create from little-endian bytes if canonical

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

Convert to little-endian bytes

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

Create from 512-bit little-endian integer mod q

pub fn hash_to_field(data: &[u8], dst: &[u8]) -> Result<Self>

Hashes arbitrary data to a scalar field element using SHA-256.

This function implements a standards-compliant hash-to-field method following the IETF hash-to-curve specification using expand_message_xmd with SHA-256.

Arguments

• data: The input data to hash.
• dst: A Domain Separation Tag (DST) to ensure hashes are unique per application context.

Returns

A Result containing the Scalar or an error.

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

Create from raw values and convert to Montgomery

pub const fn square(&self) -> Scalar

Square this element

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

Multiplicative inverse

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

Multiply two scalars

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

Subtract rhs from self

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

Add rhs to self

pub const fn neg(&self) -> Self

Negate self

Trait Implementations

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

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Scalar

type Output = Scalar

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

impl AddAssign for Scalar

fn add_assign(&mut self, rhs: Scalar)

Performs the += operation.

impl ByteSerializable for Scalar

fn to_bytes(&self) -> Vec<u8>

Convert to a byte vector

fn from_bytes(bytes: &[u8]) -> Result<Self>

Try to create from a byte slice

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConditionallySelectable for Scalar

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

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

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl ConstantTimeEq for Scalar

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

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl ConstantTimeEq for Scalar

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

Compare two values in constant time

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Default for Scalar

fn default() -> Self

Returns the “default value” for a type.

impl Display for Scalar

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

Formats the value using the given formatter.

impl<'a> From<&'a Scalar> for [u8; 32]

fn from(value: &'a Scalar) -> [u8; 32]

Converts to this type from the input type.

impl From<Scalar> for [u8; 32]

fn from(value: Scalar) -> [u8; 32]

Converts to this type from the input type.

impl From<u64> for Scalar

fn from(val: u64) -> Scalar

Converts to this type from the input type.

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

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b G1Affine) -> Self::Output

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b G1Projective) -> Self::Output

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b G2Affine) -> Self::Output

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: &'b G2Projective) -> Self::Output

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

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

type Output = Gt

The resulting type after applying the * operator.

fn mul(self, other: &'b Scalar) -> Self::Output

Performs the * operation.

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

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Gt

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: G1Affine) -> G1Projective

Performs the * operation.

impl Mul<G1Affine> for Scalar

type Output = G1Projective

The resulting type after applying the * operator.

fn mul(self, rhs: G1Affine) -> G1Projective

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<G1Projective> for Scalar

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: G2Affine) -> G2Projective

Performs the * operation.

impl Mul<G2Affine> for Scalar

type Output = G2Projective

The resulting type after applying the * operator.

fn mul(self, rhs: G2Affine) -> G2Projective

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<G2Projective> for Scalar

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Gt

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for G1Affine

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for G1Projective

type Output = G1Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for G2Affine

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for G2Projective

type Output = G2Projective

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Scalar> for Gt

type Output = Gt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Scalar

type Output = Scalar

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

Performs the *= operation.

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

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

Performs the *= operation.

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

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

Performs the *= operation.

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

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

Performs the *= operation.

impl MulAssign<Scalar> for G1Projective

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for G2Projective

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign<Scalar> for Gt

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl MulAssign for Scalar

fn mul_assign(&mut self, rhs: Scalar)

Performs the *= operation.

impl<'a> Neg for &'a Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar

Performs the unary - operation.

impl Neg for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Scalar

Performs the unary - operation.

impl PartialEq for Scalar

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> Product<T> for Scalar

where T: Borrow<Scalar>,

fn product<I>(iter: I) -> Self

where I: Iterator<Item = T>,

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

impl SecureZeroingType for Scalar

fn zeroed() -> Self

Create a zeroed instance

fn secure_clone(&self) -> Self

Create a secure clone that preserves security properties

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

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

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

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Scalar

type Output = Scalar

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

impl SubAssign for Scalar

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation.

impl<T> Sum<T> for Scalar

where T: Borrow<Scalar>,

fn sum<I>(iter: I) -> Self

where I: Iterator<Item = T>,

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

impl Copy for Scalar

impl DefaultIsZeroes for Scalar

impl Eq for Scalar