Struct GenericFieldElement

pub struct GenericFieldElement<F: PrimeField>(F);

Temporarily exported generic field to aid migration to AcirField

Tuple Fields

0: F

Implementations

impl<F: PrimeField> FieldElement<F>

pub fn from_repr(field: F) -> Self

pub fn into_repr(self) -> F

fn fits_in_u128(&self) -> bool

pub fn try_from_str(input: &str) -> Option<FieldElement<F>>

Returns None, if the string is not a canonical representation of a field element; less than the order or if the hex string is invalid. This method can be used for both hex and decimal representations.

Trait Implementations

impl<F: PrimeField> AcirField for FieldElement<F>

fn max_num_bits() -> u32

Maximum number of bits needed to represent a field element This is not the amount of bits being used to represent a field element Example, you only need 254 bits to represent a field element in BN256 But the representation uses 256 bits, so the top two bits are always zero This method would return 254

fn max_num_bytes() -> u32

Maximum numbers of bytes needed to represent a field element We are not guaranteed that the number of bits being used to represent a field element will always be divisible by 8. If the case that it is not, we add one to the max number of bytes For example, a max bit size of 254 would give a max byte size of 32.

fn num_bits(&self) -> u32

This is the number of bits required to represent this specific field element

fn inverse(&self) -> FieldElement<F>

Computes the inverse or returns zero if the inverse does not exist Before using this FieldElement, please ensure that this behavior is necessary

fn to_le_bytes(self) -> Vec<u8>

Converts the field element to a vector of bytes in little-endian order

fn from_be_bytes_reduce(bytes: &[u8]) -> FieldElement<F>

Converts bytes into a FieldElement and applies a reduction if needed.

fn from_le_bytes_reduce(bytes: &[u8]) -> FieldElement<F>

Converts bytes in little-endian order into a FieldElement and applies a reduction if needed.

fn fetch_nearest_bytes(&self, num_bits: usize) -> Vec<u8>

Returns the closest number of bytes to the bits specified This method truncates

fn one() -> FieldElement<F>

fn zero() -> FieldElement<F>

fn is_zero(&self) -> bool

fn is_one(&self) -> bool

fn pow(&self, exponent: &Self) -> Self

fn modulus() -> BigUint

fn to_u128(self) -> u128

fn try_into_u128(self) -> Option<u128>

fn to_i128(self) -> i128

fn try_into_i128(self) -> Option<i128>

fn try_to_u64(&self) -> Option<u64>

fn try_to_u32(&self) -> Option<u32>

fn to_hex(self) -> String

fn from_hex(hex_str: &str) -> Option<FieldElement<F>>

fn to_be_bytes(self) -> Vec<u8>

impl<F: PrimeField> Add for FieldElement<F>

type Output = FieldElement<F>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<F: PrimeField> AddAssign for FieldElement<F>

fn add_assign(&mut self, rhs: FieldElement<F>)

Performs the += operation.

impl<F: Clone + PrimeField> Clone for FieldElement<F>

fn clone(&self) -> FieldElement<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PrimeField> Debug for FieldElement<F>

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

Formats the value using the given formatter.

impl<F: Default + PrimeField> Default for FieldElement<F>

fn default() -> FieldElement<F>

Returns the “default value” for a type.

impl<'de, T: PrimeField> Deserialize<'de> for FieldElement<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: PrimeField> Display for FieldElement<F>

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

Formats the value using the given formatter.

impl<F: PrimeField> Div for FieldElement<F>

type Output = FieldElement<F>

The resulting type after applying the / operator.

fn div(self, rhs: FieldElement<F>) -> Self::Output

Performs the / operation.

impl<F: PrimeField> From<bool> for FieldElement<F>

fn from(boolean: bool) -> FieldElement<F>

Converts to this type from the input type.

impl<F: PrimeField> From<i128> for FieldElement<F>

fn from(a: i128) -> FieldElement<F>

Converts to this type from the input type.

impl<F: PrimeField> From<u128> for FieldElement<F>

fn from(a: u128) -> FieldElement<F>

Converts to this type from the input type.

impl<F: PrimeField> From<u32> for FieldElement<F>

fn from(a: u32) -> FieldElement<F>

Converts to this type from the input type.

impl<F: PrimeField> From<u64> for FieldElement<F>

fn from(a: u64) -> FieldElement<F>

Converts to this type from the input type.

impl<F: PrimeField> From<usize> for FieldElement<F>

fn from(a: usize) -> FieldElement<F>

Converts to this type from the input type.

impl<F: Hash + PrimeField> Hash for FieldElement<F>

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<F: PrimeField> Mul for FieldElement<F>

type Output = FieldElement<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<F: PrimeField> Neg for FieldElement<F>

type Output = FieldElement<F>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F: Ord + PrimeField> Ord for FieldElement<F>

fn cmp(&self, other: &FieldElement<F>) -> 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<F: PartialEq + PrimeField> PartialEq for FieldElement<F>

fn eq(&self, other: &FieldElement<F>) -> 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<F: PartialOrd + PrimeField> PartialOrd for FieldElement<F>

fn partial_cmp(&self, other: &FieldElement<F>) -> 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: PrimeField> Serialize for FieldElement<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: PrimeField> Sub for FieldElement<F>

type Output = FieldElement<F>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<F: PrimeField> SubAssign for FieldElement<F>

fn sub_assign(&mut self, rhs: FieldElement<F>)

Performs the -= operation.

impl<F: Copy + PrimeField> Copy for FieldElement<F>

impl<F: Eq + PrimeField> Eq for FieldElement<F>

impl<F: PrimeField> StructuralPartialEq for FieldElement<F>