Enum quad_compat_rhai::plugin::EvalAltResult

#[non_exhaustive]
pub enum EvalAltResult {
    ErrorSystem(String, Box<dyn Error>),
    ErrorParsing(ParseErrorType, Position),
    ErrorVariableNotFound(String, Position),
    ErrorFunctionNotFound(String, Position),
    ErrorInFunctionCall(String, String, Box<EvalAltResult>, Position),
    ErrorModuleNotFound(String, Position),
    ErrorInModule(String, Box<EvalAltResult>, Position),
    ErrorUnboundThis(Position),
    ErrorMismatchDataType(String, String, Position),
    ErrorMismatchOutputType(String, String, Position),
    ErrorArrayBounds(usize, INT, Position),
    ErrorStringBounds(usize, INT, Position),
    ErrorBitFieldBounds(usize, INT, Position),
    ErrorIndexingType(String, Position),
    ErrorFor(Position),
    ErrorDataRace(String, Position),
    ErrorAssignmentToConstant(String, Position),
    ErrorDotExpr(String, Position),
    ErrorArithmetic(String, Position),
    ErrorTooManyOperations(Position),
    ErrorTooManyModules(Position),
    ErrorStackOverflow(Position),
    ErrorDataTooLarge(String, Position),
    ErrorTerminated(Dynamic, Position),
    ErrorRuntime(Dynamic, Position),
    LoopBreak(bool, Position),
    Return(Dynamic, Position),
}

Evaluation result.

All wrapped Position values represent the location in the script where the error occurs.

Thread Safety

Currently, EvalAltResult is neither Send nor Sync. Turn on the sync feature to make it Send + Sync.

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.

ErrorSystem(String, Box<dyn Error>)

Tuple Fields

0: String

1: Box<dyn Error>

System error. Wrapped values are the error message and the internal error.

ErrorParsing(ParseErrorType, Position)

Tuple Fields

0: ParseErrorType

1: Position

Syntax error.

ErrorVariableNotFound(String, Position)

Tuple Fields

0: String

1: Position

Usage of an unknown variable. Wrapped value is the variable name.

ErrorFunctionNotFound(String, Position)

Tuple Fields

0: String

1: Position

Call to an unknown function. Wrapped value is the function signature.

ErrorInFunctionCall(String, String, Box<EvalAltResult>, Position)

Tuple Fields

0: String

1: String

2: Box<EvalAltResult>

3: Position

An error has occurred inside a called function. Wrapped values are the function name, function source, and the interior error.

ErrorModuleNotFound(String, Position)

Tuple Fields

0: String

1: Position

Usage of an unknown module. Wrapped value is the module name.

ErrorInModule(String, Box<EvalAltResult>, Position)

Tuple Fields

0: String

1: Box<EvalAltResult>

2: Position

An error has occurred while loading a module. Wrapped value are the module name and the interior error.

ErrorUnboundThis(Position)

Tuple Fields

0: Position

Access to this that is not bound.

ErrorMismatchDataType(String, String, Position)

Tuple Fields

0: String

1: String

2: Position

Data is not of the required type. Wrapped values are the type requested and type of the actual result.

ErrorMismatchOutputType(String, String, Position)

Tuple Fields

0: String

1: String

2: Position

Returned type is not the same as the required output type. Wrapped values are the type requested and type of the actual result.

ErrorArrayBounds(usize, INT, Position)

Tuple Fields

0: usize

1: INT

2: Position

Array access out-of-bounds. Wrapped values are the current number of elements in the array and the index number.

ErrorStringBounds(usize, INT, Position)

Tuple Fields

0: usize

1: INT

2: Position

String indexing out-of-bounds. Wrapped values are the current number of characters in the string and the index number.

ErrorBitFieldBounds(usize, INT, Position)

Tuple Fields

0: usize

1: INT

2: Position

Bit-field indexing out-of-bounds. Wrapped values are the current number of bits in the bit-field and the index number.

ErrorIndexingType(String, Position)

Tuple Fields

0: String

1: Position

Trying to index into a type that has no indexer function defined. Wrapped value is the type name.

ErrorFor(Position)

Tuple Fields

0: Position

The for statement encounters a type that is not an iterator.

ErrorDataRace(String, Position)

Tuple Fields

0: String

1: Position

Data race detected when accessing a variable. Wrapped value is the variable name.

ErrorAssignmentToConstant(String, Position)

Tuple Fields

0: String

1: Position

Assignment to a constant variable. Wrapped value is the variable name.

ErrorDotExpr(String, Position)

Tuple Fields

0: String

1: Position

Inappropriate property access. Wrapped value is the property name.

ErrorArithmetic(String, Position)

Tuple Fields

0: String

1: Position

Arithmetic error encountered. Wrapped value is the error message.

ErrorTooManyOperations(Position)

Tuple Fields

0: Position

Number of operations over maximum limit.

ErrorTooManyModules(Position)

Tuple Fields

0: Position

Modules over maximum limit.

ErrorStackOverflow(Position)

Tuple Fields

0: Position

Call stack over maximum limit.

ErrorDataTooLarge(String, Position)

Tuple Fields

0: String

1: Position

Data value over maximum size limit. Wrapped value is the type name.

ErrorTerminated(Dynamic, Position)

Tuple Fields

0: Dynamic

1: Position

The script is prematurely terminated. Wrapped value is the termination token.

ErrorRuntime(Dynamic, Position)

Tuple Fields

0: Dynamic

1: Position

Run-time error encountered. Wrapped value is the error token.

LoopBreak(bool, Position)

Tuple Fields

0: bool

1: Position

Breaking out of loops - not an error if within a loop. The wrapped value, if true, means breaking clean out of the loop (i.e. a break statement). The wrapped value, if false, means breaking the current context (i.e. a continue statement).

Return(Dynamic, Position)

Tuple Fields

0: Dynamic

1: Position

Not an error: Value returned from a script via the return keyword. Wrapped value is the result value.

Implementations

impl EvalAltResult

pub const fn is_pseudo_error(&self) -> bool

Is this a pseudo error? A pseudo error is one that does not occur naturally.

LoopBreak and Return are pseudo errors.

pub const fn is_catchable(&self) -> bool

Can this error be caught?

pub const fn is_system_exception(&self) -> bool

Is this error a system exception?

pub const fn position(&self) -> Position

Get the position of this error.

pub fn clear_position(&mut self) -> &mut Self

Remove the position information from this error.

The position of this error is set to NONE afterwards.

pub fn take_position(&mut self) -> Position

Remove the position information from this error and return it.

The position of this error is set to NONE afterwards.

pub fn set_position(&mut self, new_position: Position) -> &mut Self

Override the position of this error.

Trait Implementations

impl Debug for EvalAltResult

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

Formats the value using the given formatter.

impl Display for EvalAltResult

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

Formats the value using the given formatter.

impl Error for EvalAltResult

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl<T> From<EvalAltResult> for Result<T, Box<EvalAltResult>>

fn from(err: EvalAltResult) -> Self

Performs the conversion.

impl From<ParseError> for EvalAltResult

fn from(err: ParseError) -> Self

Performs the conversion.

impl From<ParseErrorType> for EvalAltResult

fn from(err: ParseErrorType) -> Self

Performs the conversion.

impl<T: AsRef<str>> From<T> for EvalAltResult

fn from(err: T) -> Self

Performs the conversion.