Struct cairo_vm :: Felt252 Copy item path

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. Read more

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. Read more

impl Add<&Felt> for Relocatable

type Output = Result<Relocatable, MathError>

The resulting type after applying the + operator.

fn add(self, other: &Felt252) -> Result<Relocatable, MathError>

Performs the + operation. Read more

impl Add<&Felt> for u64

type Output = Option<u64>

The resulting type after applying the + operator.

fn add(self, rhs: &Felt) -> Option<u64>

Performs the + operation. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl AddAssign<&Felt> for Felt

Field addition. Never overflows/underflows.

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

Performs the += operation. Read more

impl AddAssign for Felt

Field addition. Never overflows/underflows.

fn add_assign(&mut self, rhs: Felt)

Performs the += operation. Read more

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Felt

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

Formats the value using the given formatter. Read more

impl Default for Felt

Defaults to Felt::ZERO.

fn default() -> Felt

Returns the “default value” for a type. Read more

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. Read more

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. Read more