Enum InterpreterError 

#[non_exhaustive]
pub enum InterpreterError {
    Syntax(String),
    Security(String),
    Runtime(String),
    LimitExceeded(String),
    RecursionLimitExceeded {
        limit: u32,
    },
    Tool {
        tool_name: String,
        message: String,
    },
    NameError(String),
    TypeError(String),
    ValueError(String),
    AttributeError(String),
    AssertionError(String),
    PythonException {
        type_name: String,
        message: String,
    },
    StateFormatSuperseded {
        found: u32,
        expected: u32,
    },
}

Errors surfaced to the host (consumer of the interpreter).

All error variants carry a human-readable message. The variant determines the category of failure. Use pattern matching or Display for error reporting.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Syntax(String)

CPython-shaped prefix: SyntaxError: <msg>.

Security(String)

Sandbox-specific (no CPython equivalent — CPython doesn’t have a generic “security” rejection). Kept as-is so the prefix is recognisable as sandbox enforcement rather than a language-level error.

Runtime(String)

CPython prefix: RuntimeError: <msg>.

LimitExceeded(String)

Sandbox-specific (CPython has no operation-counter limit). Kept as-is.

RecursionLimitExceeded

CPython: RecursionError: maximum recursion depth exceeded. Distinct from LimitExceeded so callers can recognise the Python-equivalent and hint at sys.setrecursionlimit-style mitigations instead of memory exhaustion.

Fields

limit: u32

The configured max_recursion_depth that was breached.

Tool

Sandbox-specific (CPython has no tool concept).

Fields

tool_name: String

message: String

NameError(String)

CPython prefix: NameError: <message>. The inner String is the full message body (typically name 'X' is not defined), NOT just the variable name — that lets stamp_line append a line marker at the end of the rendered output instead of inside the quoted name. Use Self::name_not_defined to construct the common form.

TypeError(String)

CPython prefix: TypeError: <msg>.

ValueError(String)

CPython prefix: ValueError: <msg>.

AttributeError(String)

CPython prefix: AttributeError: <msg>.

AssertionError(String)

CPython prefix: AssertionError: <msg> (or AssertionError alone when the assert had no message). Inner String includes the message verbatim — empty when none.

PythonException

Raised-from-Python exceptions: <type_name>: <message>. Already CPython-shape since the type_name is the exception class.

Fields

type_name: String

message: String

StateFormatSuperseded

Imported state blob carries a STATE_FORMAT_VERSION the current interpreter no longer understands. The interpreter never silently migrates across format versions — pre-versioning blobs (no version prefix) are reported as found = 0, and any other mismatch surfaces the exact version found vs the version expected.

Do not feed the blob into a newer interpreter shape; restart the host workflow from a clean initial state instead.

Fields

found: u32

Version embedded in the imported blob (0 for pre-versioning blobs that have no version prefix).

expected: u32

Version this interpreter writes and accepts.

Implementations

impl InterpreterError

pub fn name_not_defined(name: impl AsRef<str>) -> Self

Build the canonical name 'X' is not defined NameError body. The inner String is the FULL message (matches CPython’s NameError: name '<n>' is not defined); callers that produce the rare other-body NameError can wrap their own String directly in Self::NameError(...).

Trait Implementations

impl Clone for InterpreterError

fn clone(&self) -> InterpreterError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InterpreterError

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

Formats the value using the given formatter.

impl Display for InterpreterError

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

Formats the value using the given formatter.

impl Error for InterpreterError

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.