Go to file

Stephen Chung ac218e23c6 Merge branch 'master' of https://github.com/jonathandturner/rhai		2020-07-25 14:02:04 +08:00
.ci	Split `no_stdlib` and `no_std` into two features.	2020-03-18 12:04:26 +08:00
.github/workflows	Restore benchmark.yml.	2020-07-25 09:47:50 +08:00
benches	More benchmarks and examples.	2020-05-31 23:44:49 +08:00
doc	Add currying support.	2020-07-22 23:12:09 +08:00
examples	Remove no_std example.	2020-07-19 23:32:16 +08:00
no_std/no_std_test	Change no_std sample to bare-bones.	2020-07-22 11:43:58 +08:00
scripts	Fix scripts and tests.	2020-06-27 21:19:53 +08:00
src	Avoid shadowing indexer errors.	2020-07-25 09:55:33 +08:00
tests	Fix Module::set_indexer_set_fn.	2020-07-24 23:16:54 +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	Avoid pulling in std for no-std.	2020-07-20 20:23:35 +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	README.md: Add License section (based on Syn)	2020-07-25 07:08:16 +02:00
RELEASES.md	Fix Module::set_indexer_set_fn.	2020-07-24 23:16:54 +08:00
rhai_logo.png	Refactor.	2020-06-29 23:55:28 +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

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

Protection against attacks

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.

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 of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.