Go to file

Stephen Chung 16fbfbb606 Enable call in function-call style.		2020-07-16 12:09:31 +08:00
.ci	Split `no_stdlib` and `no_std` into two features.	2020-03-18 12:04:26 +08:00
.github/workflows	Move benchmark.yml to correct location.	2020-07-04 15:43:48 +08:00
benches	More benchmarks and examples.	2020-05-31 23:44:49 +08:00
doc	Enable call in function-call style.	2020-07-16 12:09:31 +08:00
examples	Add doc to serde example.	2020-07-04 22:52:45 +08:00
scripts	Fix scripts and tests.	2020-06-27 21:19:53 +08:00
src	Enable call in function-call style.	2020-07-16 12:09:31 +08:00
tests	Enable call in function-call style.	2020-07-16 12:09:31 +08:00
.gitignore	Expose FnPtr and move name checking into	2020-07-06 21:30:35 +08:00
.travis.yml	Added no_std support	2020-03-17 19:26:11 +01:00
Cargo.toml	Bump version.	2020-07-14 08:42:02 +08:00
LICENSE.txt	Add LICENSE.	2020-03-22 00:32:07 +08:00
README.md	Update docs.	2020-07-13 13:41:01 +08:00
RELEASES.md	Enable call in function-call style.	2020-07-16 12:09:31 +08:00
rhai_logo.png	Refactor.	2020-06-29 23:55:28 +08:00

Rhai - Embedded Scripting for Rust

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

Supported targets and builds

Easy-to-use language similar to JavaScript+Rust with dynamic typing.
Tight integration with native Rust functions and types, including getters/setters, methods and indexers.
Freely pass Rust variables/constants into a script via an external Scope.
Easily call a script-defined function from Rust.
Fairly low compile-time overhead.
Fairly efficient evaluation (1 million iterations in 0.3 sec on a single core, 2.3 GHz Linux VM).
Relatively little unsafe code (yes there are some for performance reasons, and most unsafe code is limited to one single source file, all with names starting with "unsafe_").
Re-entrant scripting engine can be made Send + Sync (via the sync feature).
Function overloading.
Operator overloading.
Dynamic dispatch via function pointers.
Some support for object-oriented programming (OOP).
Organize code base with dynamically-loadable modules.
Serialization/deserialization support via serde (requires the serde feature).
Scripts are optimized (useful for template-based machine-generated scripts) for repeated evaluations.
Support for minimal builds by excluding unneeded language features.

Sand-boxed - the scripting engine, if declared immutable, cannot mutate the containing environment unless explicitly permitted (e.g. via a RefCell).
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.

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

An Online Playground is available with syntax-highlighting editor. Scripts can be evaluated directly from the editor.