Enum ValueOrArray

pub enum ValueOrArray {
    MemoryAddress(MemoryAddress),
    HeapArray(HeapArray),
    HeapVector(HeapVector),
}

Lays out various ways an external foreign call’s input and output data may be interpreted inside Brillig. This data can either be an individual value or memory.

While we are usually agnostic to how memory is passed within Brillig, this needs to be encoded somehow when dealing with an external system. For simplicity, the extra type information is given right in the ForeignCall instructions.

Variants

MemoryAddress(MemoryAddress)

A single value to be passed to or from an external call. It is an ‘immediate’ value - used without dereferencing. For a foreign call input, the value is read directly from memory. For a foreign call output, the value is written directly to memory.

HeapArray(HeapArray)

An array to be passed to or from an external call. In the case of a foreign call input, the array is read from this Brillig memory location + size more cells. In the case of a foreign call output, the array is written to this Brillig memory location with the size being here just as a sanity check for the write size.

HeapVector(HeapVector)

A vector to be passed to or from an external call. In the case of a foreign call input, the vector is read from this Brillig memory location + as many cells as the second address indicates. In the case of a foreign call output, the vector is written to this Brillig memory location as ‘size’ cells, with size being stored in the second address.

Trait Implementations

impl Clone for ValueOrArray

fn clone(&self) -> ValueOrArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValueOrArray

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValueOrArray

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ValueOrArray

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

Formats the value using the given formatter.

impl Hash for ValueOrArray

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 PartialEq for ValueOrArray

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ValueOrArray

impl Eq for ValueOrArray

impl StructuralPartialEq for ValueOrArray