Struct starknet_crypto::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]) -> FieldElement

Create a new FieldElement from its Montgomery representation

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

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

pub fn from_bytes_be( bytes: &[u8; 32] ) -> Result<FieldElement, 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<FieldElement, FromByteSliceError>

Same as from_bytes_be except this function takes a slice.

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) -> <FieldElement as Add>::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) -> <FieldElement as BitAnd>::Output

Performs the & operation.

impl BitOr for FieldElement

type Output = FieldElement

The resulting type after applying the | operator.

fn bitor(self, rhs: FieldElement) -> <FieldElement as BitOr>::Output

Performs the | operation.

impl Clone for FieldElement

fn clone(&self) -> FieldElement

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for FieldElement

fn default() -> FieldElement

Returns the “default value” for a type.

impl Display for FieldElement

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

Formats the value using the given formatter.

impl From<u128> for FieldElement

fn from(value: u128) -> FieldElement

Converts to this type from the input type.

impl From<u16> for FieldElement

fn from(value: u16) -> FieldElement

Converts to this type from the input type.

impl From<u32> for FieldElement

fn from(value: u32) -> FieldElement

Converts to this type from the input type.

impl From<u64> for FieldElement

fn from(value: u64) -> FieldElement

Converts to this type from the input type.

impl From<u8> for FieldElement

fn from(value: u8) -> FieldElement

Converts to this type from the input type.

impl From<usize> for FieldElement

fn from(value: usize) -> FieldElement

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<FieldElement, <FieldElement as FromStr>::Err>

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

impl Hash for FieldElement

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

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

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) -> <FieldElement as Mul>::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) -> <FieldElement as Neg>::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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FieldElement

fn eq(&self, other: &FieldElement) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method 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) -> <FieldElement as Rem>::Output

Performs the % operation.

impl Sub for FieldElement

type Output = FieldElement

The resulting type after applying the - operator.

fn sub(self, rhs: FieldElement) -> <FieldElement as Sub>::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>(iter: I) -> FieldElement

where I: Iterator<Item = &'a FieldElement>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for FieldElement

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

where I: Iterator<Item = FieldElement>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl UpperHex for FieldElement

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

Formats the value using the given formatter.

impl Copy for FieldElement

impl Eq for FieldElement

impl StructuralPartialEq for FieldElement