Enum ForeignCallParam

pub enum ForeignCallParam<F> {
    Single(F),
    Array(Vec<F>),
}

Single input or output of a foreign call.

This enum can represent either a single field element or an array of field elements.

The #[serde(untagged)] attribute uses the natural JSON representation: Single(5) serializes as 5, and Array([1,2,3]) serializes as [1,2,3]. This allows external systems to pass values directly without needing to know about Rust enum variants, relying on JSON’s native distinction between single values and arrays.

Variants

Single(F)

A single field element value.

Array(Vec<F>)

Multiple field element values (array or vector passed by value).

Implementations

impl<F: AcirField> ForeignCallParam<F>

pub fn fields(&self) -> Vec<F>

Convert the parameter into a uniform vector representation.

This is useful for flattening data when processing foreign call results, allowing both Single and Array variants to be handled uniformly as Vec<F>.

pub fn unwrap_field(&self) -> F

Unwrap the field in a Single input. Panics if it’s an Array.

Trait Implementations

impl<F: Clone> Clone for ForeignCallParam<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ForeignCallParam<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for ForeignCallParam<F>

where F: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F> From<F> for ForeignCallParam<F>

fn from(value: F) -> Self

Converts to this type from the input type.

impl<F> From<Vec<F>> for ForeignCallParam<F>

fn from(values: Vec<F>) -> Self

Converts to this type from the input type.

impl<F: PartialEq> PartialEq for ForeignCallParam<F>

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

where F: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Eq> Eq for ForeignCallParam<F>

impl<F> StructuralPartialEq for ForeignCallParam<F>