Struct Fq 

pub struct Fq(pub Fp<MontBackend<FqConfig, 4>, 4>);

A BN254 base field element (also the Grumpkin scalar field).

Tuple Fields

0: Fp<MontBackend<FqConfig, 4>, 4>

Implementations

impl Fq

pub const fn zero() -> Fq

The additive identity (zero).

pub const fn one() -> Fq

The multiplicative identity (one).

pub fn from_hex(value: &str) -> Result<Fq, Error>

Parse from a hex string (e.g. "0x01").

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

Serialize to 32-byte big-endian representation.

pub fn from_be_bytes_mod_order(bytes: &[u8]) -> Fq

Interpret a variable-length big-endian byte slice as an Fq element, reducing modulo the field order.

This accepts slices of any length (e.g. 64 bytes from SHA-512).

pub fn is_zero(&self) -> bool

Returns true if this field element is zero.

pub fn random() -> Fq

Generate a random field element.

pub fn hi(&self) -> Fr

Upper 128 bits as an Fr element.

Matches the TS Fq.hi getter: new Fr(this.toBigInt() >> 128n).

pub fn lo(&self) -> Fr

Lower 128 bits as an Fr element.

Matches the TS Fq.lo getter: new Fr(this.toBigInt() & ((1n << 128n) - 1n)).

Trait Implementations

impl Clone for Fq

fn clone(&self) -> Fq

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fq

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

Formats the value using the given formatter.

impl Default for Fq

fn default() -> Fq

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fq

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fq

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

Formats the value using the given formatter.

impl From<[u8; 32]> for Fq

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

Converts to this type from the input type.

impl From<u64> for Fq

fn from(value: u64) -> Fq

Converts to this type from the input type.

impl Hash for Fq

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Mul for Fq

type Output = Fq

The resulting type after applying the * operator.

fn mul(self, rhs: Fq) -> <Fq as Mul>::Output

Performs the * operation.

impl Ord for Fq

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

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

fn partial_cmp(&self, other: &Fq) -> 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 Serialize for Fq

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Fq

impl Eq for Fq

impl StructuralPartialEq for Fq