Enum MemoryValue

pub enum MemoryValue<F> {
    Field(F),
    U1(bool),
    U8(u8),
    U16(u16),
    U32(u32),
    U64(u64),
    U128(u128),
}

A single typed value in the Brillig VM’s memory.

Memory in the VM is strongly typed and can represent either a native field element or an integer of a specific bit width. This enum encapsulates all supported in-memory types and allows conversion between representations.

Variants

Field(F)

U1(bool)

U8(u8)

U16(u16)

U32(u32)

U64(u64)

U128(u128)

Implementations

impl<F: Display> MemoryValue<F>

pub fn new_field(value: F) -> Self

Builds a field-typed memory value.

pub fn new_integer(value: u128, bit_size: IntegerBitSize) -> Self

Builds an integer-typed memory value.

pub fn bit_size(&self) -> BitSize

pub fn to_u32(&self) -> u32

Expects a U32 value and converts it into usize, otherwise panics.

Primarily a convenience method for using values in memory operations as pointers, sizes and offsets.

impl<F: AcirField> MemoryValue<F>

pub fn new_from_field(value: F, bit_size: BitSize) -> Self

Builds a memory value from a field element, either field or integer type.

If the bit size indicates an integer type, the value is downcast to fit into the specified size.

pub fn new_checked(value: F, bit_size: BitSize) -> Option<Self>

Builds a memory value from a field element, checking that the value is within the bit size, otherwise returns None.

pub fn to_field(&self) -> F

Converts the memory value to a field element, independent of its type.

pub fn to_u128(&self) -> Result<u128, MemoryTypeError>

Converts the memory value to U128, if the value is an integer.

pub fn expect_field(self) -> Result<F, MemoryTypeError>

Extracts the field element from the memory value, if it is typed as field element.

pub(crate) fn expect_u1(self) -> Result<bool, MemoryTypeError>

pub(crate) fn expect_u8(self) -> Result<u8, MemoryTypeError>

pub(crate) fn expect_u16(self) -> Result<u16, MemoryTypeError>

pub(crate) fn expect_u32(self) -> Result<u32, MemoryTypeError>

pub(crate) fn expect_u64(self) -> Result<u64, MemoryTypeError>

pub(crate) fn expect_u128(self) -> Result<u128, MemoryTypeError>

Trait Implementations

impl<F: Clone> Clone for MemoryValue<F>

fn clone(&self) -> MemoryValue<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for MemoryValue<F>

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

Formats the value using the given formatter.

impl<F: AcirField> Default for MemoryValue<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Display> Display for MemoryValue<F>

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

Formats the value using the given formatter.

impl<F: AcirField> From<bool> for MemoryValue<F>

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<F: AcirField> From<u128> for MemoryValue<F>

fn from(value: u128) -> Self

Converts to this type from the input type.

impl<F: AcirField> From<u32> for MemoryValue<F>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<F: AcirField> From<u64> for MemoryValue<F>

fn from(value: u64) -> Self

Converts to this type from the input type.

impl<F: AcirField> From<u8> for MemoryValue<F>

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<F: Ord> Ord for MemoryValue<F>

fn cmp(&self, other: &MemoryValue<F>) -> 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<F: PartialEq> PartialEq for MemoryValue<F>

fn eq(&self, other: &MemoryValue<F>) -> 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<F: PartialOrd> PartialOrd for MemoryValue<F>

fn partial_cmp(&self, other: &MemoryValue<F>) -> 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<F: AcirField> TryFrom<MemoryValue<F>> for bool

type Error = MemoryTypeError

The type returned in the event of a conversion error.

fn try_from(memory_value: MemoryValue<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: AcirField> TryFrom<MemoryValue<F>> for u128

type Error = MemoryTypeError

The type returned in the event of a conversion error.

fn try_from(memory_value: MemoryValue<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: AcirField> TryFrom<MemoryValue<F>> for u32

type Error = MemoryTypeError

The type returned in the event of a conversion error.

fn try_from(memory_value: MemoryValue<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: AcirField> TryFrom<MemoryValue<F>> for u64

type Error = MemoryTypeError

The type returned in the event of a conversion error.

fn try_from(memory_value: MemoryValue<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: AcirField> TryFrom<MemoryValue<F>> for u8

type Error = MemoryTypeError

The type returned in the event of a conversion error.

fn try_from(memory_value: MemoryValue<F>) -> Result<Self, Self::Error>

Performs the conversion.

impl<F: Copy> Copy for MemoryValue<F>

impl<F: Eq> Eq for MemoryValue<F>

impl<F> StructuralPartialEq for MemoryValue<F>