Go to file

Stephen Chung 8c47d61456 Refine documentation and comments.		2021-01-11 23:09:33 +08:00
.github/workflows	Revert "Delete benchmark.yml"	2021-01-09 00:26:49 +08:00
benches	Engine::register_global_module and Engine::register_static_module must be passed shared Module.	2020-12-23 10:08:43 +08:00
codegen	Refine documentation and comments.	2021-01-11 23:09:33 +08:00
examples	Move rhai-repl and rhai-doc to bin.	2020-12-29 15:36:42 +08:00
no_std/no_std_test	Update URL links.	2021-01-07 17:30:06 +08:00
scripts	Change rhai_runner and repl to rhai-run and rhai-repl.	2020-12-25 16:08:56 +08:00
src	Refine documentation and comments.	2021-01-11 23:09:33 +08:00
tests	Fix test.	2021-01-09 16:57:21 +08:00
.gitignore	Remove doc/book from .gitignore.	2021-01-07 22:52:08 +08:00
Cargo.toml	Update URL links.	2021-01-07 17:30:06 +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	Refine documentation and comments.	2021-01-11 23:09:33 +08:00
RELEASES.md	Refine documentation and comments.	2021-01-11 23:09:33 +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 - all clonable Rust types are supported; no need to implement any special trait.
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.

Protected 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.