Modules§
- Configuration for Rhai.
- Module containing all built-in packages available to Rhai, plus facilities to define custom packages.
- Module defining macros for developing plugins.
- (serde) Serialization and deserialization support for
serde
. Exported under theserde
feature only.
Macros§
- Macro to combine a plugin module into an existing module.
- Macro that makes it easy to define a package (which is basically a shared module) and register functions into it.
- Macro to generate a Rhai
Module
from a plugin module defined via#[export_module]
. - Macro to register a plugin function (defined via
#[export_fn]
) into anEngine
. - Macro to register a plugin function into a Rhai
Module
. - Macro to register a plugin function into a Rhai
Module
and expose it globally.
Structs§
- Compiled AST (abstract syntax tree) of a Rhai script.
- Dynamic type containing any value.
- Rhai main scripting engine.
- Context of a script evaluation process.
- An expression sub-tree in an
AST
. - A general function pointer, which may carry additional (i.e. curried) argument values to be passed onto a function during a call.
- Type for fine-tuned module function registration.
- The system immutable string type.
- A measurement of a monotonically nondecreasing clock. Opaque and useful only with
Duration
. - A reader-writer lock
- A module which may contain variables, sub-modules, external Rust functions, and/or script-defined functions.
- Context of a native Rust function call.
- Error when parsing a script.
- A location (line number + character position) in the input script.
- Type containing information about the current scope. Useful for keeping state between
Engine
evaluation runs. - A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
- Builder to build the API of a custom type for use with an
Engine
. - Information on a variable declaration.
Enums§
- Evaluation result.
- A type representing the access mode of a function.
- A type representing the namespace of a function.
- Error encountered when tokenizing the script text.
- Error encountered when parsing a script.
Constants§
- Standard debug-print function.
- Standard pretty-print function.
- Standard containment testing function.
- Standard equality comparison operator.
Traits§
- Trait to build the API of a custom type for use with an
Engine
(i.e. register the type and its getters, setters, methods, etc.). - Trait that parses arguments to a function call.
- Trait to register custom Rust functions.
Functions§
- Evaluate a string as a script, returning the result value or an error.
- Evaluate a script file, returning the result value or an error.
- Return the JSON representation of an object map.
- Evaluate a string as a script.
- Evaluate a file.
Type Aliases§
- Variable-sized array of
Dynamic
values. - Variable-sized array of
u8
values (byte array). - The system integer type. It is defined as
i32
since theonly_i32
feature is used. - A dictionary of
Dynamic
values with string keys.
Attribute Macros§
- Attribute, when put on a Rust function, turns it into a plugin function.
- Attribute, when put on a Rust module, turns it into a plugin module.
- Macro to automatically expose a Rust function, type-def or use statement as
pub
when under theinternals
feature.
Derive Macros§
- Macro to implement the [
CustomType
][rhai::CustomType] trait.