Enum OperationError 

pub enum OperationError {
    CircularExternalNode(Word),
    DivideByZero,
    Deferred(PrecompileError),
    FailedAssertion {
        err_code: Felt,
        err_msg: Option<Arc<str>>,
    },
    U32AssertionFailed {
        err_code: Felt,
        err_msg: Option<Arc<str>>,
        invalid_values: Vec<Felt>,
    },
    FriError(String),
    InvalidMerklePathLength {
        path_len: usize,
        depth: Felt,
    },
    InvalidStackDepthOnReturn {
        depth: usize,
    },
    LogArgumentZero,
    MalformedMastForestInHost {
        root_digest: Word,
    },
    MerklePathVerificationFailed {
        inner: Box<MerklePathVerificationFailedInner>,
    },
    NotBinaryValue {
        context: BinaryValueErrorContext,
        value: Felt,
    },
    NotU32Values {
        values: Vec<Felt>,
    },
    SyscallTargetNotInKernel {
        proc_root: Word,
    },
    Internal(&'static str),
}

Lightweight error type for operations that can fail.

This enum captures error conditions without expensive context information (no source location, no file references). When an OperationError propagates up to become an ExecutionError, the context is resolved lazily via extension traits like OperationResultExt::map_exec_err.

Adding new errors (for contributors)

Use OperationError when:

• The error occurs during operation execution (e.g., assertion failures, type mismatches)
• Context can be resolved at the call site via the extension traits
• The error needs both a human-readable message and optional diagnostic help

Avoid duplicating error context. Context is added by the extension traits, so do NOT add label or source_file fields to the variant.

Pattern at call sites:

// Return OperationError and let the caller wrap it:
fn some_op() -> Result<(), OperationError> {
    Err(OperationError::DivideByZero)
}

// Caller wraps with context lazily:
some_op().map_exec_err()?;

For wrapper errors (AdviceError, EventError, AceError), use the corresponding extension traits (AdviceResultExt, AceResultExt) or helper functions (advice_error_with_context, event_error_with_context).

Variants

CircularExternalNode(Word)

DivideByZero

Deferred(PrecompileError)

FailedAssertion

Fields

err_code: Felt

err_msg: Option<Arc<str>>

U32AssertionFailed

Fields

err_code: Felt

err_msg: Option<Arc<str>>

invalid_values: Vec<Felt>

FriError(String)

InvalidMerklePathLength

Fields

path_len: usize

depth: Felt

InvalidStackDepthOnReturn

Fields

depth: usize

LogArgumentZero

MalformedMastForestInHost

Fields

root_digest: Word

MerklePathVerificationFailed

Fields

inner: Box<MerklePathVerificationFailedInner>

NotBinaryValue

Fields

context: BinaryValueErrorContext

value: Felt

NotU32Values

Fields

values: Vec<Felt>

SyscallTargetNotInKernel

Fields

proc_root: Word

Internal(&'static str)

Implementations

impl OperationError

pub fn with_context(self) -> ExecutionError

Wraps this error with execution context to produce an ExecutionError.

This is useful when working with ControlFlow or other non-Result return types where the OperationResultExt::map_exec_err extension trait cannot be used directly.

pub fn with_package_source_context( self, context: PackageSourceDebugContext<'_>, host: &dyn BaseHost, op_idx: Option<usize>, ) -> ExecutionError

Wraps this error with package-owned source-occurrence execution context.

Unlike Self::with_context, this resolves source metadata from package debug sections keyed by a source/debug MAST occurrence rather than by the reduced execution MAST node.

Trait Implementations

impl Clone for OperationError

fn clone(&self) -> OperationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationError

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

Formats the value using the given formatter.

impl Diagnostic for OperationError

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source<'a>(&'a self) -> Option<&'a dyn Diagnostic>

The cause of the error.

impl Display for OperationError

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

Formats the value using the given formatter.

impl Error for OperationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<PrecompileError> for OperationError

fn from(source: PrecompileError) -> OperationError

Converts to this type from the input type.