Go to file

Stephen Chung d35c216465 Add README's.		2020-10-07 22:56:21 +08:00
.github/workflows	Update CI to enforce clippy::perf	2020-09-20 13:11:15 -05:00
benches	Add README's.	2020-10-07 22:56:21 +08:00
codegen	Add README's.	2020-10-07 22:56:21 +08:00
doc	Add README for docs.	2020-10-07 13:23:28 +08:00
examples	Add README's.	2020-10-07 22:56:21 +08:00
no_std/no_std_test	Put no_std_test into its own empty workspace	2020-09-08 16:17:58 -05:00
scripts	Add README's.	2020-10-07 22:56:21 +08:00
src	Fix serde typo.	2020-10-07 15:51:00 +08:00
tests	Add README's.	2020-10-07 22:56:21 +08:00
.gitignore	Improve shared value treatment.	2020-08-08 16:24:10 +08:00
Cargo.toml	Bump version.	2020-10-03 23:29:34 +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	Add instructions on how to build The Book.	2020-10-07 10:43:39 +08:00
RELEASES.md	Add AST::combine and AST::combine_filtered.	2020-10-07 12:11:25 +08:00

README.md

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.
Fairly low compile-time overhead.
Fairly efficient evaluation (1 million iterations in 0.3 sec on a single core, 2.3 GHz Linux VM).
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.
Relatively little unsafe code (yes there are some for performance reasons).
Few dependencies (currently only smallvec).
Re-entrant scripting engine can be made Send + Sync (via the sync feature).
Scripts are optimized (useful for template-based machine-generated scripts) for repeated evaluations.
Easy custom API development via plugins system powered by procedural macros.
Function overloading and operator overloading.
Dynamic dispatch via function pointers with additional support for currying.
Closures (anonymous functions) that can capture shared values.
Some syntactic support for object-oriented programming (OOP).
Organize code base with dynamically-loadable modules.
Serialization/deserialization support via serde (requires the serde feature).
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.

To build The Book, first install mdbook and mdbook-tera (for templating). Running mdbook build builds it.

Playground

An Online Playground is available with syntax-highlighting editor. 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.