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<'a> Decode<'a> for Felt

fn decode_iter<T>(iter: &mut T) -> Result<Felt, Error>

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

Converts into the type from an iterator of references to Felt.

fn decode<T>(reader: T) -> Result<Self, Error>

where T: IntoIterator<Item = &'a Felt>,

Converts into the type from a list of Felt.

impl Default for Felt

Defaults to Felt::ZERO.

fn default() -> Felt

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Felt

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Encode for Felt

fn encode<W>(&self, writer: &mut W) -> Result<(), Error>

where W: FeltWriter,

Converts the type into a list of Felt and append them into the writer.

impl FeltWriter for Felt

fn write(&mut self, felt: Felt)

Adds a single Felt element into the writer.

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<EthAddress> for Felt

fn from(value: EthAddress) -> Felt

Converts to this type from the input type.

impl From<EthAddress> for Felt

fn from(value: EthAddress) -> Felt

Converts to this type from the input type.

impl From<LegacyEntrypointOffset> for Felt

fn from(value: LegacyEntrypointOffset) -> Felt

Converts to this type from the input type.

impl From<LegacyEntrypointOffset> for Felt

fn from(value: LegacyEntrypointOffset) -> 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 FromPrimitive for Felt

fn from_i64(value: i64) -> Option<Felt>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(value: u64) -> Option<Felt>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(value: i128) -> Option<Felt>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(value: u128) -> Option<Felt>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

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 Inv for Felt

type Output = Option<Felt>

The result after applying the operator.

fn inv(self) -> <Felt as Inv>::Output

Returns the multiplicative inverse of self.

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 One for Felt

fn one() -> Felt

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

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 Pow<u128> for Felt

type Output = Felt

The result after applying the operator.

fn pow(self, rhs: u128) -> <Felt as Pow<u128>>::Output

Returns self to the power rhs.

impl Pow<u16> for Felt

type Output = Felt

The result after applying the operator.

fn pow(self, rhs: u16) -> <Felt as Pow<u16>>::Output

Returns self to the power rhs.

impl Pow<u32> for Felt

type Output = Felt

The result after applying the operator.

fn pow(self, rhs: u32) -> <Felt as Pow<u32>>::Output

Returns self to the power rhs.

impl Pow<u64> for Felt

type Output = Felt

The result after applying the operator.

fn pow(self, rhs: u64) -> <Felt as Pow<u64>>::Output

Returns self to the power rhs.

impl Pow<u8> for Felt

type Output = Felt

The result after applying the operator.

fn pow(self, rhs: u8) -> <Felt as Pow<u8>>::Output

Returns self to the power rhs.

impl Serialize for Felt

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 SizeOf for Felt

fn size_of_children(&self, _context: &mut Context)

Gets the size of all “children” owned by this value, not including the size of the value itself.

fn size_of(&self) -> TotalSize

Gets the total size of the current value

fn size_of_with_context(&self, context: &mut Context)

Adds the size of the current value to the given Context, including both the size of the value itself and all of its children

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 ToBigInt for Felt

fn to_bigint(&self) -> Option<BigInt>

Converts the value of self to a [BigInt].

Safe to unwrap, will always return Some.

impl ToBigUint for Felt

fn to_biguint(&self) -> Option<BigUint>

Converts the value of self to a [BigUint].

Safe to unwrap, will always return Some.

impl ToPrimitive for Felt

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

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

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

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl TryFrom<&Hash256> for Felt

type Error = ToFieldElementError

The type returned in the event of a conversion error.

fn try_from(value: &Hash256) -> Result<Felt, <Felt as TryFrom<&Hash256>>::Error>

Performs the conversion.

impl TryFrom<&Hash256> for Felt

type Error = ToFieldElementError

The type returned in the event of a conversion error.

fn try_from(value: &Hash256) -> Result<Felt, <Felt as TryFrom<&Hash256>>::Error>

Performs the conversion.

impl TryFrom<Hash256> for Felt

type Error = ToFieldElementError

The type returned in the event of a conversion error.

fn try_from(value: Hash256) -> Result<Felt, <Felt as TryFrom<Hash256>>::Error>

Performs the conversion.

impl TryFrom<Hash256> for Felt

type Error = ToFieldElementError

The type returned in the event of a conversion error.

fn try_from(value: Hash256) -> Result<Felt, <Felt as TryFrom<Hash256>>::Error>

Performs the conversion.

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 Zero for Felt

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn zero() -> Felt

Returns the additive identity element of Self, 0.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for Felt

impl Eq for Felt

impl StructuralPartialEq for Felt