Enum MemoryValue

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

Expand description

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_usize(&self) -> usize

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 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<F: Debug> Debug for MemoryValue<F>

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

Formats the value using the given formatter. Read more

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

fn default() -> Self

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

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

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

Formats the value using the given formatter. Read more

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: AcirField> From<usize> for MemoryValue<F>

fn from(value: usize) -> 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. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

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 ==.

1.0.0 · Source§

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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>

Auto Trait Implementations§

impl<F> Freeze for MemoryValue<F>
where F: Freeze,

impl<F> RefUnwindSafe for MemoryValue<F>
where F: RefUnwindSafe,

impl<F> Send for MemoryValue<F>
where F: Send,

impl<F> Sync for MemoryValue<F>
where F: Sync,

impl<F> Unpin for MemoryValue<F>
where F: Unpin,

impl<F> UnwindSafe for MemoryValue<F>
where F: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

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

Performs copy-assignment from self to dst. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SectionExt for T
where T: Display + Send + Sync + 'static,

Add a header to a Section and indent the body Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more