Struct falcon::il::Constant

pub struct Constant { /* fields omitted */ }

A constant value for Falcon IL

IL Constants in Falcon are backed by both rust's u64 primitive, and BigUint from the num-bigint crate. This allows modelling and simulation of instructions which must operate on values >64 bits in size. When a Constant has 64 or less bits, the u64 will be used, incurring minimal performance overhead.

The Falcon IL Expression operations are provided as methods over Constant.

Methods

impl Constant

pub fn new(value: u64, bits: usize) -> Constant

Create a new Constant with the given value and bitness.

pub fn new_big(value: BigUint, bits: usize) -> Constant

Create a new Constant from the given BigUint.

pub fn from_decimal_string(s: &String, bits: usize) -> Result<Constant>

Crates a constant from a decimal string of the value

pub fn new_zero(bits: usize) -> Constant

Create a new Constant with the given bits and a value of zero

pub fn value_u64(&self) -> Option<u64>

Get the value of this Constant if it is a u64.

pub fn value_i64(&self) -> Option<i64>

Sign-extend the constant out to 64-bits, and return it as an i64

pub fn value(&self) -> &BigUint

Get the value of this Constant if it is a BigUint.

pub fn bits(&self) -> usize

Get the number of bits for this Constant.

pub fn is_zero(&self) -> bool

Returns true if the value in this Constant is 0, false otherwise.

pub fn is_one(&self) -> bool

Returns true if the value in this constant is 1, false otherwise.

pub fn add(&self, rhs: &Constant) -> Result<Constant>

pub fn sub(&self, rhs: &Constant) -> Result<Constant>

pub fn mul(&self, rhs: &Constant) -> Result<Constant>

pub fn divu(&self, rhs: &Constant) -> Result<Constant>

pub fn modu(&self, rhs: &Constant) -> Result<Constant>

pub fn divs(&self, rhs: &Constant) -> Result<Constant>

pub fn mods(&self, rhs: &Constant) -> Result<Constant>

pub fn and(&self, rhs: &Constant) -> Result<Constant>

pub fn or(&self, rhs: &Constant) -> Result<Constant>

pub fn xor(&self, rhs: &Constant) -> Result<Constant>

pub fn shl(&self, rhs: &Constant) -> Result<Constant>

pub fn shr(&self, rhs: &Constant) -> Result<Constant>

pub fn cmpeq(&self, rhs: &Constant) -> Result<Constant>

pub fn cmpneq(&self, rhs: &Constant) -> Result<Constant>

pub fn cmpltu(&self, rhs: &Constant) -> Result<Constant>

pub fn cmplts(&self, rhs: &Constant) -> Result<Constant>

pub fn trun(&self, bits: usize) -> Result<Constant>

pub fn zext(&self, bits: usize) -> Result<Constant>

pub fn sext(&self, bits: usize) -> Result<Constant>

Trait Implementations

impl Clone for Constant

fn clone(&self) -> Constant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Constant

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Constant

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

Deserialize this value from the given Serde deserializer.

impl Display for Constant

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Constant

impl Hash for Constant

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Into<Expression> for Constant

fn into(self) -> Expression

Performs the conversion.

impl Ord for Constant

fn cmp(&self, other: &Constant) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Constant> for Constant

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

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

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

This method tests for !=.

impl PartialOrd<Constant> for Constant

fn partial_cmp(&self, other: &Constant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Constant) -> bool

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

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

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

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

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

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

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

impl Serialize for Constant

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Constant

impl StructuralPartialEq for Constant

impl Value for Constant

fn constant(constant: Constant) -> Self

Turn an il::Constant into a representation of this Value

fn bits(&self) -> usize

Return the number of bits contained in this value

fn shl(&self, bits: usize) -> Result<Self>

Shift the value left by the given number of bits

fn shr(&self, bits: usize) -> Result<Self>

Shift the value right by the given number of bits

fn trun(&self, bits: usize) -> Result<Self>

Truncate the value to the given number of bits

fn zext(&self, bits: usize) -> Result<Self>

Zero-extend the value to the given number of bits

fn or(&self, other: &Self) -> Result<Self>

Or this value with the given value