Enum FailureReason

pub enum FailureReason {
    Trap {
        revert_data_offset: u32,
        revert_data_size: u32,
    },
    RuntimeError {
        message: String,
    },
}

Represents the reason why the Brillig VM failed during execution.

Variants

Trap

A trap was encountered, which indicates an explicit failure from within the VM program.

A trap is triggered explicitly by the [trap opcode][Opcode::Trap]. The revert data is referenced by the offset and size in the VM memory.

Fields

revert_data_offset: u32

Offset in memory where the revert data begins.

revert_data_size: u32

Size of the revert data.

RuntimeError

A runtime failure during execution. This error is triggered by all opcodes aside the [trap opcode][Opcode::Trap]. For example, a [binary operation][Opcode::BinaryIntOp] can trigger a division by zero error.

Fields

message: String

Trait Implementations

impl Clone for FailureReason

fn clone(&self) -> FailureReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FailureReason

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

Formats the value using the given formatter.

impl PartialEq for FailureReason

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

impl StructuralPartialEq for FailureReason