Struct Fr 

pub struct Fr(pub Fp<MontBackend<FrConfig, 4>, 4>);

A BN254 scalar field element.

This is the main field type used throughout the Aztec protocol for addresses, hashes, note values, and other scalar quantities.

Tuple Fields

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

Implementations

impl Fr

pub const fn zero() -> Fr

The additive identity (zero).

pub const fn one() -> Fr

The multiplicative identity (one).

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

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

pub fn random() -> Fr

Generate a random field element.

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

Serialize to 32-byte big-endian representation.

pub fn to_usize(&self) -> usize

Extract as a usize. Only valid for small field elements.

Panics on overflow if the field element exceeds usize::MAX.

pub fn is_zero(&self) -> bool

Returns true if this field element is zero.

Trait Implementations

impl Clone for Fr

fn clone(&self) -> Fr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fr

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

Formats the value using the given formatter.

impl Default for Fr

fn default() -> Fr

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Fr

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fr

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

Formats the value using the given formatter.

impl From<[u8; 32]> for Fr

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

Converts to this type from the input type.

impl From<AztecAddress> for Fr

fn from(value: AztecAddress) -> Fr

Converts to this type from the input type.

impl From<EthAddress> for Fr

fn from(value: EthAddress) -> Fr

Converts to this type from the input type.

impl From<Fr> for AztecAddress

fn from(value: Fr) -> AztecAddress

Converts to this type from the input type.

impl From<FunctionSelector> for Fr

fn from(value: FunctionSelector) -> Fr

Converts to this type from the input type.

impl From<bool> for Fr

fn from(value: bool) -> Fr

Converts to this type from the input type.

impl From<i64> for Fr

fn from(value: i64) -> Fr

Converts to this type from the input type.

impl From<u128> for Fr

fn from(value: u128) -> Fr

Converts to this type from the input type.

impl From<u64> for Fr

fn from(value: u64) -> Fr

Converts to this type from the input type.

impl Hash for Fr

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 Ord for Fr

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

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

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

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 Fr

impl Eq for Fr

impl StructuralPartialEq for Fr