|
|
||
|---|---|---|
| .github/workflows | ||
| benches | ||
| codegen | ||
| diag_test | ||
| doc | ||
| examples | ||
| no_std/no_std_test | ||
| scripts | ||
| src | ||
| tests | ||
| .gitignore | ||
| Cargo.toml | ||
| LICENSE-APACHE.txt | ||
| LICENSE-MIT.txt | ||
| README.md | ||
| RELEASES.md | ||
| rhai_logo.png | ||
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
- All common CPU targets for Windows, Linux and MacOS.
- WebAssembly (WASM)
no-std- Minimum Rust version 1.45
Standard features
- 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
unsafecode (yes there are some for performance reasons). - Re-entrant scripting engine can be made
Send + Sync(via thesyncfeature). - Function overloading.
- Operator overloading.
- Dynamic dispatch via function pointers with additional support for currying and closures.
- Some support for object-oriented programming (OOP).
- Organize code base with dynamically-loadable modules.
- Serialization/deserialization support via serde (requires the
serdefeature). - Scripts are optimized (useful for template-based machine-generated scripts) for repeated evaluations.
- Support for minimal builds by excluding unneeded language features.
Protection against attacks
- 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
- Use as a DSL.
- Restrict the language by surgically disabling keywords and operators.
- Define custom operators.
- Extend the language with custom syntax.
Documentation
See The Rhai Book for details on the Rhai scripting engine and language.
Playground
An Online Playground is available with syntax-highlighting editor. Scripts can be evaluated directly from the editor.
License
Licensed under either:
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.