Struct Felt252 

pub struct Felt252 { /* private fields */ }

Implementations

impl Felt252

pub fn new<T>(value: T) -> Felt252

where T: Into<Felt252>,

pub fn modpow(&self, exponent: &Felt252, modulus: &Felt252) -> Felt252

👎Deprecated

pub fn iter_u64_digits(&self) -> U64Digits<'_>

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

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

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

pub fn to_signed_bytes_le(&self) -> Vec<u8>

👎Deprecated

pub fn to_bytes_be(&self) -> Vec<u8>

pub fn parse_bytes(buf: &[u8], radix: u32) -> Option<Felt252>

pub fn from_bytes_be(bytes: &[u8]) -> Felt252

pub fn from_bytes_le(bytes: &[u8]) -> Felt252

pub fn from_bytes_ne(bytes: &[u8]) -> Felt252

pub fn to_str_radix(&self, radix: u32) -> String

pub fn to_signed_felt(&self) -> BigInt

Converts Felt252 into a BigInt number in the range: (- FIELD / 2, FIELD / 2).

Examples

let positive = Felt252::new(5);
assert_eq!(positive.to_signed_felt(), Into::<num_bigint::BigInt>::into(5));

let negative = Felt252::max_value();
assert_eq!(negative.to_signed_felt(), Into::<num_bigint::BigInt>::into(-1));

pub fn to_bigint(&self) -> BigInt

pub fn to_biguint(&self) -> BigUint

Converts Felt252 into a BigUint number.

Examples

let positive = Felt252::new(5);
assert_eq!(positive.to_biguint(), Into::<num_bigint::BigUint>::into(5_u32));

let negative = Felt252::max_value();
assert_eq!(negative.to_biguint(), BigUint::from_str_radix("800000000000011000000000000000000000000000000000000000000000000", 16).unwrap());

pub fn sqrt(&self) -> Felt252

pub fn bits(&self) -> u64

pub fn prime() -> BigUint

Trait Implementations

impl<'a> Add<&'a Felt252> for Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: &Felt252) -> <Felt252 as Add<&'a Felt252>>::Output

Performs the + operation.

impl Add<u32> for Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: u32) -> Felt252

Performs the + operation.

impl Add<u64> for &Felt252

type Output = Felt252

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<usize> for &'a Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> <&'a Felt252 as Add<usize>>::Output

Performs the + operation.

impl Add<usize> for Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Felt252

Performs the + operation.

impl<'a> Add for &'a Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: &'a Felt252) -> <&'a Felt252 as Add>::Output

Performs the + operation.

impl Add for Felt252

type Output = Felt252

The resulting type after applying the + operator.

fn add(self, rhs: Felt252) -> Felt252

Performs the + operation.

impl<'a> AddAssign<&'a Felt252> for Felt252

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

Performs the += operation.

impl AddAssign for Felt252

fn add_assign(&mut self, rhs: Felt252)

Performs the += operation.

impl<'a> BitAnd<&'a Felt252> for Felt252

type Output = Felt252

The resulting type after applying the & operator.

fn bitand(self, rhs: &Felt252) -> Felt252

Performs the & operation.

impl<'a> BitAnd<Felt252> for &'a Felt252

type Output = Felt252

The resulting type after applying the & operator.

fn bitand( self, rhs: <&'a Felt252 as BitAnd<Felt252>>::Output, ) -> <&'a Felt252 as BitAnd<Felt252>>::Output

Performs the & operation.

impl<'a> BitAnd for &'a Felt252

type Output = Felt252

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Felt252) -> <&'a Felt252 as BitAnd>::Output

Performs the & operation.

impl<'a> BitOr for &'a Felt252

type Output = Felt252

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Felt252) -> <&'a Felt252 as BitOr>::Output

Performs the | operation.

impl<'a> BitXor for &'a Felt252

type Output = Felt252

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Felt252) -> <&'a Felt252 as BitXor>::Output

Performs the ^ operation.

impl Bounded for Felt252

fn min_value() -> Felt252

Returns the smallest finite number this type can represent

fn max_value() -> Felt252

Returns the largest finite number this type can represent

impl Clone for Felt252

fn clone(&self) -> Felt252

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Felt252

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

Formats the value using the given formatter.

impl Default for Felt252

fn default() -> Felt252

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Felt252

fn deserialize<__D>( __deserializer: __D, ) -> Result<Felt252, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Felt252

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

Formats the value using the given formatter.

impl<'a> Div<Felt252> for &'a Felt252

type Output = Felt252

The resulting type after applying the / operator.

fn div( self, rhs: <&'a Felt252 as Div<Felt252>>::Output, ) -> <&'a Felt252 as Div<Felt252>>::Output

Performs the / operation.

impl<'a> Div for &'a Felt252

type Output = Felt252

The resulting type after applying the / operator.

fn div(self, rhs: &'a Felt252) -> <&'a Felt252 as Div>::Output

Performs the / operation.

impl Div for Felt252

type Output = Felt252

The resulting type after applying the / operator.

fn div(self, rhs: Felt252) -> Felt252

Performs the / operation.

impl From<&BigInt> for Felt252

fn from(value: &BigInt) -> Felt252

Converts to this type from the input type.

impl From<&BigUint> for Felt252

fn from(value: &BigUint) -> Felt252

Converts to this type from the input type.

impl From<BigInt> for Felt252

fn from(value: BigInt) -> Felt252

Converts to this type from the input type.

impl From<BigUint> for Felt252

fn from(value: BigUint) -> Felt252

Converts to this type from the input type.

impl From<bool> for Felt252

fn from(flag: bool) -> Felt252

Converts to this type from the input type.

impl From<i128> for Felt252

fn from(value: i128) -> Felt252

Converts to this type from the input type.

impl From<i16> for Felt252

fn from(value: i16) -> Felt252

Converts to this type from the input type.

impl From<i32> for Felt252

fn from(value: i32) -> Felt252

Converts to this type from the input type.

impl From<i64> for Felt252

fn from(value: i64) -> Felt252

Converts to this type from the input type.

impl From<i8> for Felt252

fn from(value: i8) -> Felt252

Converts to this type from the input type.

impl From<isize> for Felt252

fn from(value: isize) -> Felt252

Converts to this type from the input type.

impl From<u128> for Felt252

fn from(value: u128) -> Felt252

Converts to this type from the input type.

impl From<u16> for Felt252

fn from(value: u16) -> Felt252

Converts to this type from the input type.

impl From<u32> for Felt252

fn from(value: u32) -> Felt252

Converts to this type from the input type.

impl From<u64> for Felt252

fn from(value: u64) -> Felt252

Converts to this type from the input type.

impl From<u8> for Felt252

fn from(value: u8) -> Felt252

Converts to this type from the input type.

impl From<usize> for Felt252

fn from(value: usize) -> Felt252

Converts to this type from the input type.

impl FromPrimitive for Felt252

fn from_u64(n: u64) -> Option<Felt252>

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_i64(n: i64) -> Option<Felt252>

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_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_i128(n: i128) -> Option<Self>

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_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_u128(n: u128) -> Option<Self>

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_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 Hash for Felt252

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 Integer for Felt252

fn div_floor(&self, rhs: &Felt252) -> Felt252

Floored integer division.

fn div_rem(&self, other: &Felt252) -> (Felt252, Felt252)

Simultaneous truncated integer division and modulus. Returns (quotient, remainder).

fn divides(&self, other: &Felt252) -> bool

👎Deprecated: Please use is_multiple_of instead

Deprecated, use is_multiple_of instead.

fn gcd(&self, other: &Felt252) -> Felt252

Greatest Common Divisor (GCD).

fn is_even(&self) -> bool

Returns true if the number is even.

fn is_multiple_of(&self, other: &Felt252) -> bool

Returns true if self is a multiple of other.

fn is_odd(&self) -> bool

Returns true if the number is odd.

fn lcm(&self, other: &Felt252) -> Felt252

Lowest Common Multiple (LCM).

fn mod_floor(&self, rhs: &Felt252) -> Felt252

Floored integer modulo, satisfying:

fn div_ceil(&self, other: &Self) -> Self

Ceiled integer division.

fn gcd_lcm(&self, other: &Self) -> (Self, Self)

Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) together.

fn extended_gcd(&self, other: &Self) -> ExtendedGcd<Self>

where Self: Clone,

Greatest common divisor and Bézout coefficients.

fn extended_gcd_lcm(&self, other: &Self) -> (ExtendedGcd<Self>, Self)

where Self: Clone + Signed,

Greatest common divisor, least common multiple, and Bézout coefficients.

fn div_mod_floor(&self, other: &Self) -> (Self, Self)

Simultaneous floored integer division and modulus. Returns (quotient, remainder).

fn next_multiple_of(&self, other: &Self) -> Self

where Self: Clone,

Rounds up to nearest multiple of argument.

fn prev_multiple_of(&self, other: &Self) -> Self

where Self: Clone,

Rounds down to nearest multiple of argument.

fn dec(&mut self)

where Self: Clone,

Decrements self by one.

fn inc(&mut self)

where Self: Clone,

Increments self by one.

impl<'a> Mul<&'a Felt252> for Felt252

type Output = Felt252

The resulting type after applying the * operator.

fn mul(self, rhs: &Felt252) -> Felt252

Performs the * operation.

impl<'a> Mul for &'a Felt252

type Output = Felt252

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Felt252) -> <&'a Felt252 as Mul>::Output

Performs the * operation.

impl Mul for Felt252

type Output = Felt252

The resulting type after applying the * operator.

fn mul(self, rhs: Felt252) -> Felt252

Performs the * operation.

impl<'a> MulAssign<&'a Felt252> for Felt252

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

Performs the *= operation.

impl<'a> Neg for &'a Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn neg(self) -> <&'a Felt252 as Neg>::Output

Performs the unary - operation.

impl Neg for Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn neg(self) -> Felt252

Performs the unary - operation.

impl Num for Felt252

type FromStrRadixErr = ParseFeltError

fn from_str_radix( string: &str, radix: u32, ) -> Result<Felt252, <Felt252 as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl One for Felt252

fn one() -> Felt252

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

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

impl Ord for Felt252

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

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

fn partial_cmp(&self, other: &Felt252) -> 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<'a> Pow<&'a Felt252> for &'a Felt252

type Output = Felt252

The result after applying the operator.

fn pow(self, rhs: &'a Felt252) -> <&'a Felt252 as Pow<&'a Felt252>>::Output

Returns self to the power rhs.

impl<'a> Pow<u32> for &'a Felt252

type Output = Felt252

The result after applying the operator.

fn pow(self, rhs: u32) -> <&'a Felt252 as Pow<u32>>::Output

Returns self to the power rhs.

impl Pow<u32> for Felt252

type Output = Felt252

The result after applying the operator.

fn pow(self, rhs: u32) -> Felt252

Returns self to the power rhs.

impl<'a> Rem<&'a Felt252> for Felt252

type Output = Felt252

The resulting type after applying the % operator.

fn rem(self, rhs: &Felt252) -> Felt252

Performs the % operation.

impl Rem for Felt252

type Output = Felt252

The resulting type after applying the % operator.

fn rem(self, rhs: Felt252) -> Felt252

Performs the % operation.

impl Serialize for Felt252

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<'a> Shl<u32> for &'a Felt252

type Output = Felt252

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> <&'a Felt252 as Shl<u32>>::Output

Performs the << operation.

impl Shl<u32> for Felt252

type Output = Felt252

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> Felt252

Performs the << operation.

impl<'a> Shl<usize> for &'a Felt252

type Output = Felt252

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> <&'a Felt252 as Shl<usize>>::Output

Performs the << operation.

impl Shl<usize> for Felt252

type Output = Felt252

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Felt252

Performs the << operation.

impl<'a> Shr<u32> for &'a Felt252

type Output = Felt252

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> <&'a Felt252 as Shr<u32>>::Output

Performs the >> operation.

impl Shr<u32> for Felt252

type Output = Felt252

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Felt252

Performs the >> operation.

impl ShrAssign<usize> for Felt252

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Signed for Felt252

fn abs(&self) -> Felt252

Computes the absolute value.

fn abs_sub(&self, other: &Felt252) -> Felt252

The positive difference of two numbers.

fn signum(&self) -> Felt252

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<'a> Sub<&'a Felt252> for Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: &Felt252) -> Felt252

Performs the - operation.

impl<'a> Sub<u32> for &'a Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: u32) -> <&'a Felt252 as Sub<u32>>::Output

Performs the - operation.

impl Sub<u32> for Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: u32) -> Felt252

Performs the - operation.

impl Sub<usize> for Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Felt252

Performs the - operation.

impl<'a> Sub for &'a Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Felt252) -> <&'a Felt252 as Sub>::Output

Performs the - operation.

impl Sub for Felt252

type Output = Felt252

The resulting type after applying the - operator.

fn sub(self, rhs: Felt252) -> Felt252

Performs the - operation.

impl<'a> SubAssign<&'a Felt252> for Felt252

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

Performs the -= operation.

impl SubAssign for Felt252

fn sub_assign(&mut self, rhs: Felt252)

Performs the -= operation.

impl Sum for Felt252

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

where I: Iterator<Item = Felt252>,

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

impl ToPrimitive for Felt252

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_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_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_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_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 Zero for Felt252

fn zero() -> Felt252

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

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

impl Eq for Felt252

impl StructuralPartialEq for Felt252