Go to file
Stephen Chung a6e294da5b
Merge pull request #466 from wackbyte/docs-and-typo
Fix some rustdoc warnings and a typo in FLOAT's docs
2021-10-22 11:59:26 +08:00
.github/workflows Merge pull request #439 from schungx/master 2021-08-21 13:05:04 +08:00
benches Change Engine::consume_XXX to Engine::run_XXX. 2021-08-17 15:50:56 +08:00
codegen Fix some rustdoc warnings and a typo in FLOAT's docs 2021-10-21 22:43:30 -04:00
examples Change Engine::consume_XXX to Engine::run_XXX. 2021-08-17 15:50:56 +08:00
no_std/no_std_test Remove no_std_repl. 2021-07-26 22:24:11 +08:00
scripts Extract expected result. 2021-09-27 11:13:48 +08:00
src Fix some rustdoc warnings and a typo in FLOAT's docs 2021-10-21 22:43:30 -04:00
tests Merge branch 'bug-fixes' 2021-09-28 16:55:33 +08:00
.gitignore Ignore benches/results. 2021-03-02 21:50:39 +08:00
Cargo.toml Turn on smartstring/serde with metadata. 2021-09-28 19:19:17 +08:00
CHANGELOG.md Turn on smartstring/serde with metadata. 2021-09-28 19:19:17 +08:00
LICENSE-APACHE.txt Remove appendix from LICENSE-APACHE.txt 2020-07-25 07:08:13 +02:00
LICENSE-MIT.txt Add LICENSE-MIT.txt (based on Syn) 2020-07-25 07:08:16 +02:00
README.md Turn on smartstring/serde with metadata. 2021-09-28 19:19:17 +08:00

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.