Struct ShiftedValueIndex

pub struct ShiftedValueIndex {
    pub value_index: ValueIndex,
    pub shift_variant: ShiftVariant,
    pub amount: usize,
}

Similar to ValueIndex, but represents a value that has been shifted by a certain amount.

This is used in the operands to constraints like AndConstraint.

The canonical formto represent a value without any shifting is ShiftVariant::Sll with amount equals 0.

Fields

value_index: ValueIndex

The index of this value in the input values vector.

shift_variant: ShiftVariant

The flavour of the shift that the value must be shifted by.

amount: usize

The number of bits by which the value must be shifted by.

Must be less than 64.

Implementations

impl ShiftedValueIndex

pub fn plain(value_index: ValueIndex) -> Self

Create a value index that just uses the specified value. Equivalent to Self::sll with amount equals 0.

pub fn sll(value_index: ValueIndex, amount: usize) -> Self

Shift Left Logical by the given number of bits.

Panics

Panics if the shift amount is greater than or equal to 64.

pub fn srl(value_index: ValueIndex, amount: usize) -> Self

Shift Right Logical by the given number of bits.

Panics

Panics if the shift amount is greater than or equal to 64.

pub fn sar(value_index: ValueIndex, amount: usize) -> Self

Shift Right Arithmetic by the given number of bits.

This is similar to the Shift Right Logical but instead of shifting in 0 bits it will replicate the sign bit.

Panics

Panics if the shift amount is greater than or equal to 64.

Trait Implementations

impl Clone for ShiftedValueIndex

fn clone(&self) -> ShiftedValueIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShiftedValueIndex

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

Formats the value using the given formatter.

impl DeserializeBytes for ShiftedValueIndex

fn deserialize(read_buf: impl Buf) -> Result<Self, SerializationError>

where Self: Sized,

impl Hash for ShiftedValueIndex

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ShiftedValueIndex

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

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

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

fn serialize(&self, write_buf: impl BufMut) -> Result<(), SerializationError>

impl Copy for ShiftedValueIndex

impl Eq for ShiftedValueIndex

impl StructuralPartialEq for ShiftedValueIndex