Struct Felt

pub struct Felt(/* private fields */);

Definition of the Field Element type.

Implementations

impl Felt

pub const ZERO: Felt

Felt constant that’s equal to 0.

pub const ONE: Felt

Felt constant that’s equal to 1.

pub const TWO: Felt

Felt constant that’s equal to 2.

pub const THREE: Felt

Felt constant that’s equal to 3.

pub const MAX: Felt

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

pub const ELEMENT_UPPER_BOUND: Felt

2 ** 251

pub const fn from_raw(val: [u64; 4]) -> Felt

Creates a new Felt from the raw internal representation. See UnsignedInteger to understand how it works under the hood.

pub const fn from_hex_unchecked(val: &str) -> Felt

pub fn from_bytes_be(bytes: &[u8; 32]) -> Felt

Creates a new Felt from its big-endian representation in a [u8; 32] array. This is as performant as from_bytes_le.

pub fn from_bytes_le(bytes: &[u8; 32]) -> Felt

Creates a new Felt from its little-endian representation in a [u8; 32] array. This is as performant as from_bytes_le.

pub fn from_bytes_be_slice(bytes: &[u8]) -> Felt

Creates a new Felt from its big-endian representation in a u8 slice. This is as performant as from_bytes_le. All bytes in the slice are consumed, as if first creating a big integer from them, but the conversion is performed in constant space on the stack.

pub fn from_bytes_le_slice(bytes: &[u8]) -> Felt

Creates a new Felt from its little-endian representation in a u8 slice. This is as performant as from_bytes_be. All bytes in the slice are consumed, as if first creating a big integer from them, but the conversion is performed in constant space on the stack.

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

Converts to big-endian byte representation in a u8 array. This is as performant as to_bytes_le

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

Converts to little-endian byte representation in a u8 array. This is as performant as to_bytes_be

pub fn to_hex_string(&self) -> String

Helper to produce a hexadecimal formatted string. Equivalent to calling format!("{self:#x}").

pub fn to_fixed_hex_string(&self) -> String

Helper to produce a hexadecimal formatted string of 66 chars.

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

Converts to little-endian bit representation.

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

Converts to big-endian bit representation.

pub fn field_div(&self, rhs: &NonZeroFelt) -> Felt

Finite field division.

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

Truncated quotient between self and rhs.

pub fn div_rem(&self, rhs: &NonZeroFelt) -> (Felt, Felt)

Quotient and remainder between self and rhs.

pub fn inverse(&self) -> Option<Felt>

Multiplicative inverse inside field.

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

Finds the square root. There may be 2 roots for each square, and the lower one is returned.

pub fn square(&self) -> Felt

Raises self to the power of 2.

pub fn double(&self) -> Felt

Doubles the point self

pub fn pow(&self, exponent: impl Into<u128>) -> Felt

Raises self to the power of exponent.

pub fn pow_felt(&self, exponent: &Felt) -> Felt

Raises self to the power of exponent.

pub fn mul_mod(&self, rhs: &Felt, p: &NonZeroFelt) -> Felt

Modular multiplication between self and rhs in modulo p.

pub fn mod_inverse(&self, p: &NonZeroFelt) -> Option<Felt>

Multiplicative inverse of self in modulo p.

pub fn mod_floor(&self, n: &NonZeroFelt) -> Felt

Remainder of dividing self by n as integers.

pub fn from_hex(hex_string: &str) -> Result<Felt, FromStrError>

Parse a hex-encoded number into Felt.

pub fn from_dec_str(dec_string: &str) -> Result<Felt, FromStrError>

Parse a decimal-encoded number into Felt.

pub fn to_raw_reversed(&self) -> [u64; 4]

Returns the internal representation of a felt and reverses it to match starknet-rs mont representation

pub fn to_raw(&self) -> [u64; 4]

Returns the internal representation of a felt

pub fn to_le_digits(&self) -> [u64; 4]

Convert self’s representative into an array of u64 digits, least significant digits first.

pub fn to_be_digits(&self) -> [u64; 4]

Convert self’s representative into an array of u64 digits, most significant digits first.

pub fn bits(&self) -> usize

Count the minimum number of bits needed to express self’s representative.

pub fn to_biguint(&self) -> BigUint

pub fn to_bigint(&self) -> BigInt

Trait Implementations

impl Add<&Felt> for &Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: &Felt) -> <&Felt as Add<&Felt>>::Output

Performs the + operation.

impl Add<&Felt> for Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: &Felt) -> <Felt as Add<&Felt>>::Output

Performs the + operation.

impl Add<Felt> for &Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: Felt) -> <&Felt as Add<Felt>>::Output

Performs the + operation.

impl Add<u64> for &Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <&Felt as Add<u64>>::Output

Performs the + operation.

impl Add<u64> for Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> <Felt as Add<u64>>::Output

Performs the + operation.

impl Add for Felt

Field addition. Never overflows/underflows.

type Output = Felt

The resulting type after applying the + operator.

fn add(self, rhs: Felt) -> <Felt as Add>::Output

Performs the + operation.

impl AddAssign<&Felt> for Felt

Field addition. Never overflows/underflows.

fn add_assign(&mut self, rhs: &Felt)

Performs the += operation.

impl AddAssign for Felt

Field addition. Never overflows/underflows.

fn add_assign(&mut self, rhs: Felt)

Performs the += operation.

impl AsRef<Felt> for Felt

fn as_ref(&self) -> &Felt

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

impl Clone for Felt

fn clone(&self) -> Felt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Felt

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

Formats the value using the given formatter.

impl Default for Felt

Defaults to Felt::ZERO.

fn default() -> Felt

Returns the “default value” for a type.

impl Display for Felt

Represents Felt in decimal by default.

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

Formats the value using the given formatter.

impl From<&BigInt> for Felt

fn from(bigint: &BigInt) -> Felt

Converts to this type from the input type.

impl From<&BigUint> for Felt

fn from(biguint: &BigUint) -> Felt

Converts to this type from the input type.

impl From<&NonZeroFelt> for Felt

fn from(value: &NonZeroFelt) -> Felt

Converts to this type from the input type.

impl From<BigInt> for Felt

fn from(bigint: BigInt) -> Felt

Converts to this type from the input type.

impl From<BigUint> for Felt

fn from(biguint: BigUint) -> Felt

Converts to this type from the input type.

impl From<NonZeroFelt> for Felt

fn from(value: NonZeroFelt) -> Felt

Converts to this type from the input type.

impl From<bool> for Felt

fn from(value: bool) -> Felt

Converts to this type from the input type.

impl From<i128> for Felt

fn from(value: i128) -> Felt

Converts to this type from the input type.

impl From<i16> for Felt

fn from(value: i16) -> Felt

Converts to this type from the input type.

impl From<i32> for Felt

fn from(value: i32) -> Felt

Converts to this type from the input type.

impl From<i64> for Felt

fn from(value: i64) -> Felt

Converts to this type from the input type.

impl From<i8> for Felt

fn from(value: i8) -> Felt

Converts to this type from the input type.

impl From<isize> for Felt

fn from(value: isize) -> Felt

Converts to this type from the input type.

impl From<u128> for Felt

fn from(value: u128) -> Felt

Converts to this type from the input type.

impl From<u16> for Felt

fn from(value: u16) -> Felt

Converts to this type from the input type.

impl From<u32> for Felt

fn from(value: u32) -> Felt

Converts to this type from the input type.

impl From<u64> for Felt

fn from(value: u64) -> Felt

Converts to this type from the input type.

impl From<u8> for Felt

fn from(value: u8) -> Felt

Converts to this type from the input type.

impl From<usize> for Felt

fn from(value: usize) -> Felt

Converts to this type from the input type.

impl FromStr for Felt

fn from_str(s: &str) -> Result<Felt, <Felt as FromStr>::Err>

Converts a hex (0x-prefixed) or decimal string to a Felt. e.g., ‘0x123abc’ or ‘1337’.

type Err = FromStrError

The associated error which can be returned from parsing.

impl Hash for Felt

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 Felt

Represents Felt in lowercase hexadecimal format.

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

Formats the value using the given formatter.

impl Mul<&Felt> for &Felt

Field multiplication. Never overflows/underflows.

type Output = Felt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<&Felt> for Felt

Field multiplication. Never overflows/underflows.

type Output = Felt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Felt> for &Felt

Field multiplication. Never overflows/underflows.

type Output = Felt

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Felt

Field multiplication. Never overflows/underflows.

type Output = Felt

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&Felt> for Felt

Field multiplication. Never overflows/underflows.

fn mul_assign(&mut self, rhs: &Felt)

Performs the *= operation.

impl MulAssign for Felt

Field multiplication. Never overflows/underflows.

fn mul_assign(&mut self, rhs: Felt)

Performs the *= operation.

impl Neg for &Felt

type Output = Felt

The resulting type after applying the - operator.

fn neg(self) -> <&Felt as Neg>::Output

Performs the unary - operation.

impl Neg for Felt

type Output = Felt

The resulting type after applying the - operator.

fn neg(self) -> <Felt as Neg>::Output

Performs the unary - operation.

impl Ord for Felt

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

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

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

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: &Felt) -> <&Felt as Sub<&Felt>>::Output

Performs the - operation.

impl Sub<&Felt> for Felt

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: &Felt) -> <Felt as Sub<&Felt>>::Output

Performs the - operation.

impl Sub<Felt> for &Felt

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: Felt) -> <&Felt as Sub<Felt>>::Output

Performs the - operation.

impl Sub<u64> for &Felt

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <&Felt as Sub<u64>>::Output

Performs the - operation.

impl Sub<u64> for Felt

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> <Felt as Sub<u64>>::Output

Performs the - operation.

impl Sub for Felt

Field subtraction. Never overflows/underflows.

type Output = Felt

The resulting type after applying the - operator.

fn sub(self, rhs: Felt) -> <Felt as Sub>::Output

Performs the - operation.

impl SubAssign<&Felt> for Felt

Field subtraction. Never overflows/underflows.

fn sub_assign(&mut self, rhs: &Felt)

Performs the -= operation.

impl SubAssign for Felt

Field subtraction. Never overflows/underflows.

fn sub_assign(&mut self, rhs: Felt)

Performs the -= operation.

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

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

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

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

impl Sum for Felt

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

where I: Iterator<Item = Felt>,

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

impl UpperHex for Felt

Represents Felt in uppercase hexadecimal format.

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

Formats the value using the given formatter.

impl Copy for Felt

impl Eq for Felt

impl StructuralPartialEq for Felt