Go to file

J Henry Waugh bcf14025a7 Add rhai_fn nested attribute and skip fn parameter		2020-08-15 21:51:45 -05:00
.github/workflows	Run CI on every push to plugins branch	2020-08-14 16:27:47 -05:00
benches	Fix benchmarks.	2020-07-29 16:09:48 +08:00
codegen	Add rhai_fn nested attribute and skip fn parameter	2020-08-15 21:51:45 -05:00
doc	Remove content on avoiding &mut ImmutableString which is invalid.	2020-08-15 00:10:14 +08:00
examples	Refine docs.	2020-08-07 18:40:31 +08:00
no_std/no_std_test	Merge branch 'master' of https://github.com/jonathandturner/rhai	2020-07-25 18:29:41 +08:00
scripts	Update docs and tests.	2020-08-04 18:39:24 +08:00
src	Move BasicStringsPackage to plugins.	2020-08-15 12:57:47 +08:00
tests	Yet more packages into plugins.	2020-08-15 00:04:10 +08:00
.gitignore	Improve shared value treatment.	2020-08-08 16:24:10 +08:00
Cargo.toml	no_closure when no_function.	2020-08-06 10:38:31 +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	Merge branch 'master' into plugins	2020-08-08 16:26:52 +08:00
RELEASES.md	Add Module::combine.	2020-08-15 00:08:00 +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
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 unsafe code (yes there are some for performance reasons).
Re-entrant scripting engine can be made Send + Sync (via the sync feature).
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 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.
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.