This repository has been archived on 2025-08-04. You can view files and clone it, but cannot push or open issues or pull requests.
rhaj/_archive/rhai_engine/rhaibook/start/examples/scripts.md
2025-04-04 08:28:07 +02:00

5.6 KiB

Example Scripts

{{#include ../../links.md}}

Language Feature Scripts

There are also a number of examples scripts that showcase Rhai's features, all in the scripts directory:

Script Description
array.rhai [arrays] example
assignment.rhai [variable] declarations
comments.rhai just regular [comments]
doc-comments.rhai [doc-comments] example
for1.rhai [for] loops
for2.rhai [for] loops with [array] iterations
for3.rhai [for] loops with [closures]
function_decl1.rhai a [function] without parameters
function_decl2.rhai a [function] with two parameters
function_decl3.rhai a [function] with many parameters
function_decl4.rhai a [function] acting as a method
function_decl5.rhai multiple [functions] as methods for different data types
if1.rhai [if] example
if2.rhai [if]-expression example
loop.rhai count-down [loop] in Rhai, emulating a [do] ... while loop
module.rhai import a script file as a module
oop.rhai simulate [object-oriented programming (OOP)][OOP] with [closures]
op1.rhai just simple addition
op2.rhai simple addition and multiplication
op3.rhai change evaluation order with parenthesis
string.rhai [string] operations, including interpolation
strings_map.rhai [string] and [object map] operations
switch.rhai [switch] example
while.rhai [while] loop

Benchmark Scripts

The following scripts are for benchmarking the speed of Rhai:

Scripts Description
speed_test.rhai a simple application to measure the speed of Rhai's interpreter (1 million iterations)
primes.rhai use Sieve of Eratosthenes to find all primes smaller than a limit
fibonacci.rhai calculate the n-th Fibonacci number using a really dumb algorithm
mat_mul.rhai matrix multiplication test to measure the speed of multi-dimensional array access

Run Example Scripts

The rhai-run utility can be used to run Rhai scripts:

cargo run --bin rhai-run scripts/any_script.rhai