Struct AssertionPayload

pub struct AssertionPayload<F> {
    pub error_selector: u64,
    pub payload: Vec<ExpressionOrMemory<F>>,
}

Payload tied to an assertion failure. This data allows users to specify feedback upon a constraint not being satisfied in the circuit.

Fields

error_selector: u64

Selector that maps a hash of either a constant string or an internal compiler error type to an ABI type. The ABI type should then be used to appropriately resolve the payload data.

payload: Vec<ExpressionOrMemory<F>>

The dynamic payload data.

Upon fetching the appropriate ABI type from the error_selector, the values in this payload can be decoded into the given ABI type. The payload is expected to be empty in the case of a constant string as the string can be contained entirely within the error type and ABI type.

Trait Implementations

impl<F: Clone> Clone for AssertionPayload<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for AssertionPayload<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for AssertionPayload<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: Hash> Hash for AssertionPayload<F>

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<F: PartialEq> PartialEq for AssertionPayload<F>

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

impl<F> StructuralPartialEq for AssertionPayload<F>