Struct FieldElement 

pub struct FieldElement { /* private fields */ }

Implementations

impl FieldElement

pub const ZERO: FieldElement

FieldElement constant that’s equal to 0

pub const ONE: FieldElement

FieldElement constant that’s equal to 1

pub const TWO: FieldElement

FieldElement constant that’s equal to 2

pub const THREE: FieldElement

FieldElement constant that’s equal to 3

pub const MAX: FieldElement

Maximum value of FieldElement. Equals to 2^251 + 17 * 2^192.

pub const fn from_mont(data: [u64; 4]) -> Self

Create a new FieldElement from its Montgomery representation

pub fn from_dec_str(value: &str) -> Result<Self, FromStrError>

pub fn from_hex_be(value: &str) -> Result<Self, FromStrError>

pub fn from_bytes_be(bytes: &[u8; 32]) -> Result<Self, FromByteArrayError>

Attempts to convert a big-endian byte representation of a field element into an element of this prime field. Returns error if the input is not canonical (is not smaller than the field’s modulus).

Arguments

• bytes: The byte array in big endian format

pub fn from_byte_slice_be(bytes: &[u8]) -> Result<Self, FromByteSliceError>

Same as from_bytes_be except this function takes a slice.

pub fn to_big_decimal<D: Into<i64>>(&self, decimals: D) -> BigDecimal

Interprets the field element as a decimal number of a certain decimal places.

pub fn to_bits_le(self) -> [bool; 256]

Transforms FieldElement into little endian bit representation.

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

Convert the field element into a big-endian byte representation

pub const fn into_mont(self) -> [u64; 4]

Transforms FieldElement into its Montgomery representation

pub fn invert(&self) -> Option<FieldElement>

pub fn sqrt(&self) -> Option<FieldElement>

pub fn double(&self) -> FieldElement

pub fn floor_div(&self, rhs: FieldElement) -> FieldElement

Performs a floor division. It’s not implemented as the Div trait on purpose to distinguish from the “felt division”.

Trait Implementations

impl Add for FieldElement

type Output = FieldElement

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for FieldElement

fn add_assign(&mut self, rhs: FieldElement)

Performs the += operation.

impl AsRef<FieldElement> for FieldElement

fn as_ref(&self) -> &FieldElement

Converts this type into a shared reference of the (usually inferred) input type.

impl BitAnd for FieldElement

type Output = FieldElement

The resulting type after applying the & operator.

fn bitand(self, rhs: FieldElement) -> Self::Output

Performs the & operation.

impl BitOr for FieldElement

type Output = FieldElement

The resulting type after applying the | operator.

fn bitor(self, rhs: FieldElement) -> Self::Output

Performs the | operation.

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldElement

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

Formats the value using the given formatter.

impl Default for FieldElement

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldElement

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FieldElement

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

Formats the value using the given formatter.

impl From<&FieldElement> for U256

fn from(value: &FieldElement) -> Self

Converts to this type from the input type.

impl From<u128> for FieldElement

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for FieldElement

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for FieldElement

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for FieldElement

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for FieldElement

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for FieldElement

fn from(value: usize) -> Self

Converts to this type from the input type.

impl FromStr for FieldElement

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FieldElement

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 LowerHex for FieldElement

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

Formats the value using the given formatter.

impl Mul for FieldElement

type Output = FieldElement

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for FieldElement

fn mul_assign(&mut self, rhs: FieldElement)

Performs the *= operation.

impl Neg for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for FieldElement

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

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

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

type Output = FieldElement

The resulting type after applying the % operator.

fn rem(self, rhs: FieldElement) -> Self::Output

Performs the % operation.

impl Serialize for FieldElement

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for FieldElement

fn sub_assign(&mut self, rhs: FieldElement)

Performs the -= operation.

impl<'a> Sum<&'a FieldElement> for FieldElement

fn sum<I: Iterator<Item = &'a FieldElement>>(iter: I) -> Self

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

impl Sum for FieldElement

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

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

impl TryFrom<FieldElement> for u128

type Error = ValueOutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<FieldElement> for u16

type Error = ValueOutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<FieldElement> for u32

type Error = ValueOutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<FieldElement> for u64

type Error = ValueOutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<FieldElement> for u8

type Error = ValueOutOfRangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UpperHex for FieldElement

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

Formats the value using the given formatter.

impl Copy for FieldElement

impl Eq for FieldElement

impl StructuralPartialEq for FieldElement