#scripting #scripting-engine #scripting-language #embedded

no-std bin+lib rhai

Embedded scripting for Rust

58 releases (11 stable)

1.2.1 Nov 24, 2021
1.1.0 Oct 11, 2021
1.0.0 Jul 7, 2021
0.20.3 Jun 22, 2021
0.2.0 Mar 26, 2016

#2 in Embedded development

Download history 2045/week @ 2021-08-15 1625/week @ 2021-08-22 1581/week @ 2021-08-29 1767/week @ 2021-09-05 2489/week @ 2021-09-12 2860/week @ 2021-09-19 2739/week @ 2021-09-26 2675/week @ 2021-10-03 3186/week @ 2021-10-10 3067/week @ 2021-10-17 3490/week @ 2021-10-24 3616/week @ 2021-10-31 3970/week @ 2021-11-07 3343/week @ 2021-11-14 3960/week @ 2021-11-21 3949/week @ 2021-11-28

15,592 downloads per month
Used in 27 crates (17 directly)

MIT/Apache

1MB
25K SLoC

Rhai - Embedded Scripting for Rust

GitHub last commit Build Status Stars License crates.io crates.io API Docs VS Code plugin installs Sublime Text package downloads Discord Chat Zulip Chat Reddit Channel

Rhai logo

Rhai is an embedded scripting language and evaluation engine for Rust that gives a safe and easy way to add scripting to any application.

Targets and builds

  • All CPU and O/S targets supported by Rust, including:
    • WebAssembly (WASM)
    • no-std
  • Minimum Rust version 1.49

Standard features

Protected against attacks

  • Don't Panic guarantee - Any panic is a bug. Rhai subscribes to the motto that a library should never panic the host system, and is coded with this in mind.
  • Sand-boxed - the scripting engine, if declared immutable, cannot mutate the containing environment unless explicitly permitted.
  • Rugged - protected against malicious attacks (such as stack-overflow, over-sized data, and runaway scripts etc.) that may come from untrusted third-party user-land scripts.
  • Track script evaluation progress and manually terminate a script run.

For those who actually want their own language

Example

The scripts subdirectory contains sample Rhai scripts.

Below is the standard Fibonacci example for scripting languages:

// This Rhai script calculates the n-th Fibonacci number using a
// really dumb algorithm to test the speed of the scripting engine.

const TARGET = 28;
const REPEAT = 5;
const ANSWER = 317_811;

fn fib(n) {
    if n < 2 {
        n
    } else {
        fib(n-1) + fib(n-2)
    }
}

print(`Running Fibonacci(${TARGET}) x ${REPEAT} times...`);
print("Ready... Go!");

let result;
let now = timestamp();

for n in range(0, REPEAT) {
    result = fib(TARGET);
}

print(`Finished. Run time = ${now.elapsed} seconds.`);

print(`Fibonacci number #${TARGET} = ${result}`);

if result != ANSWER {
    print(`The answer is WRONG! Should be ${ANSWER}!`);
}

Project Site

rhai.rs

Documentation

See The Rhai Book for details on the Rhai scripting engine and language.

Playground

An Online Playground is available with syntax-highlighting editor, powered by WebAssembly.

Scripts can be evaluated directly from the editor.

License

Licensed under either of the following, at your choice:

Unless explicitly stated otherwise, any contribution intentionally submitted for inclusion in this crate, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

Dependencies

~0.9–3MB
~65K SLoC

a