Enum ScriptError 

pub enum ScriptError {
    Compile {
        uri: String,
        line: u32,
        col: u32,
        message: String,
    },
    Runtime(String),
}

Errors a ScriptHost can surface from load or tick.

Structured compile errors carry the source URI and the offending (line, col) so editor / LSP layers can place a squiggle without re-parsing the error message. Runtime is still a free-form string; Rhai’s runtime errors don’t always carry positions and the trait-level shape is “best effort”.

Variants

Compile

Source failed to parse / compile.

Fields

uri: String

Origin URI (e.g. "main.cdl" or "lumen://app/main.cdl"); "<inline>" when the source has no associated URI.

line: u32

1-based line number reported by the parser. 0 when the position is unknown.

col: u32

1-based column number reported by the parser. 0 when the position is unknown.

message: String

Stringified parser message (sans position prefix).

Runtime(String)

Source compiled but execution failed.

Implementations

impl ScriptError

pub fn relocate(self, uri: &str, map: &SourceMap) -> Self

Point a compile error in a concatenated program at the file and line the author wrote.

uri is the program’s own name and map says where each of its pieces was read from. An error about another file (a module the program imports) already names that file and is returned unchanged, as is a runtime error or one with no known line.

pub fn compile(message: impl Into<String>) -> Self

Build a Compile with no specific position info. Equivalent to the previous Compile(String) shape; used by backends that can’t surface line/col yet.

Trait Implementations

impl Debug for ScriptError

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

Formats the value using the given formatter.

impl Display for ScriptError

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

Formats the value using the given formatter.

impl Error for ScriptError

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.