What is Rhai
❱
Features
Supported Targets and Builds
What Rhai Isn't
Licensing
Related Resources
Getting Started
❱
Online Playground
Install the Rhai Crate
Optional Features
Special Builds
❱
Performance
Minimal
no-std
WebAssembly (WASM)
Packaged Utilities
Examples
❱
Rust
Scripts
Using the Engine
❱
Hello World in Rhai – Evaluate a Script
Compile to AST for Repeated Evaluations
Evaluate Expressions Only
Raw Engine
❱
Built-in Operators
Scope – Initializing and Maintaining State
Engine Configuration Options
Extend Rhai with Rust
❱
Traits
Register a Rust Function
❱
Dynamic Parameters
String Parameters
Generic Functions
Fallible Functions
NativeCallContext
Call a Rhai Function from Rust
❱
Create a Rust Closure from a Rhai Function
Override a Built-in Function
Operator Overloading
Register any Rust Type and its Methods
❱
Property Getters and Setters
Indexers
Call Method as Function
Disable Custom Types
Printing Custom Types
Modules
❱
Create from Rust
Create from AST
Use a Module
Module Resolvers
❱
Custom Module Resolvers
Self-Contained AST
Plugins
❱
Export a Rust Module
Export a Rust Function
Packages
❱
Built-in Packages
Custom Packages
Rhai Language Reference
❱
Comments
❱
Doc-Comments
Values and Types
❱
Dynamic Values
❱
type_of()
Value Tag
Serialization/Deserialization with serde
Numbers
❱
Operators
Functions
Value Conversions
Strings and Characters
❱
ImmutableString
Built-in Functions
Arrays
Object Maps
❱
Parse from JSON
Special Support for OOP
Time-Stamps
Keywords
Statements
Variables
Constants
❱
Automatic Global Module
Logic Operators
Assignment Operators
If Statement / Expression
In Operator
Switch Expression
While Loop
Do Loop
Loop Statement
For Loop
❱
Iterators for Custom Types
Return Values
Throw Exception on Error
Catch Exceptions
Functions
❱
Method Calls
Overloading
Namespaces
Function Pointers
Currying
Anonymous Functions
Closures
Metadata
Print and Debug
Modules
❱
Export Variables, Functions and Sub-Modules
Import Modules
Eval Function
Safety and Protection
❱
Safety Checks
Sand-Boxing
Maximum Length of Strings
Maximum Size of Arrays
Maximum Size of Object Maps
Maximum Number of Operations
❱
Tracking Progress and Force-Termination
Maximum Number of Modules
Maximum Call Stack Depth
Maximum Statement Depth
Script Optimization
❱
Optimization Levels
Re-Optimize an AST
Eager Function Evaluation
Side-Effect Considerations
Volatility Considerations
Subtle Semantic Changes
Advanced Topics
❱
Manage AST's
Capture Scope for Function Call
Low-Level API
Variable Resolver
Use as DSL
❱
Disable Keywords and/or Operators
Custom Operators
Extend with Custom Syntax
Multiple Instantiation
Functions Metadata
❱
Generate Function Signatures
Export Metadata to JSON
Usage Patterns
❱
Object-Oriented Programming (OOP)
Working With Rust Enums
Loadable Configuration
Control Layer Over Rust Backend
Singleton Command
Multi-Layer Functions
One Engine Instance Per Call
Multi-Threaded Synchronization
Scriptable Event Handler with State
Dynamic Constants Provider
External Tools
❱
Online Playground
rhai-doc
Appendix
❱
Keywords
Operators and Symbols
Literals
Light (default)
Rust
Coal
Navy
Ayu
Rhai - Embedded Scripting for Rust
书馆
Getting Started
This section shows how to install the Rhai crate into a Rust application.