Struct rhai::plugin::Module [−][src]
pub struct Module { /* fields omitted */ }
Expand description
A module which may contain variables, sub-modules, external Rust functions, and/or script-defined functions.
Implementations
Get the ID of the Module
as an Identifier
, if any.
Example
use rhai::Module; let mut module = Module::new(); module.set_id(Some("hello")); assert_eq!(module.id_raw().map(|s| s.as_str()), Some("hello"));
Is the Module
indexed?
A module must be indexed before it can be used in an import
statement.
Example
use rhai::Module; let mut module = Module::new(); assert!(module.is_indexed()); module.set_native_fn("foo", |x: &mut i64, y: i64| { *x = y; Ok(()) }); assert!(!module.is_indexed()); module.build_index(); assert!(module.is_indexed());
Generate signatures for all the non-private functions in the Module
.
Exported under the metadata
feature only.
Set a script-defined function into the Module
.
If there is an existing function of the same name and number of arguments, it is replaced.
Get a shared reference to the script-defined function in the Module
based on name
and number of parameters.
pub fn set_sub_module(
&mut self,
name: impl Into<Identifier>,
sub_module: impl Into<Shared<Module>>
) -> &mut Self
pub fn set_sub_module(
&mut self,
name: impl Into<Identifier>,
sub_module: impl Into<Shared<Module>>
) -> &mut Self
Does the particular Rust function exist in the Module
?
The u64
hash is returned by the set_native_fn
call.
Example
use rhai::Module; let mut module = Module::new(); let hash = module.set_native_fn("calc", || Ok(42_i64)); assert!(module.contains_fn(hash));
Update the metadata (parameter names/types and return type) of a registered function.
Exported under the metadata
feature only.
The u64
hash is returned by the set_native_fn
call.
Parameter Names and Types
Each parameter name/type pair should be a single string of the format: var_name: type
.
Return Type
The last entry in the list should be the return type of the function. In other words, the number of entries should be one larger than the number of parameters.
Update the namespace of a registered function.
The u64
hash is returned by the set_native_fn
call.
Set a Rust function into the Module
, returning a hash key.
If there is an existing Rust function of the same hash, it is replaced.
WARNING - Low Level API
This function is very low level.
pub fn set_raw_fn<N, T, F>(
&mut self,
name: N,
namespace: FnNamespace,
access: FnAccess,
arg_types: &[TypeId],
func: F
) -> u64 where
N: AsRef<str> + Into<Identifier>,
T: Variant + Clone,
F: Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
pub fn set_raw_fn<N, T, F>(
&mut self,
name: N,
namespace: FnNamespace,
access: FnAccess,
arg_types: &[TypeId],
func: F
) -> u64 where
N: AsRef<str> + Into<Identifier>,
T: Variant + Clone,
F: Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
Set a Rust function taking a reference to the scripting Engine
,
the current set of functions, plus a list of mutable Dynamic
references
into the Module
, returning a hash key.
Use this to register a built-in function which must reference settings on the scripting
Engine
(e.g. to prevent growing an array beyond the allowed maximum size),
or to call a script-defined function in the current evaluation context.
If there is a similar existing Rust function, it is replaced.
WARNING - Low Level API
This function is very low level.
Arguments
A list of TypeId
’s is taken as the argument types.
Arguments are simply passed in as a mutable array of &mut Dynamic
,
which is guaranteed to contain enough arguments of the correct types.
The function is assumed to be a method, meaning that the first argument should not be consumed. All other arguments can be consumed.
To access a primary argument value (i.e. cloning is cheap), use: args[n].as_xxx().unwrap()
To access an argument value and avoid cloning, use std::mem::take(args[n]).cast::<T>()
.
Notice that this will consume the argument, replacing it with ()
.
To access the first mutable argument, use args.get_mut(0).unwrap()
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::{Module, FnNamespace, FnAccess}; let mut module = Module::new(); let hash = module.set_raw_fn("double_or_not", FnNamespace::Internal, FnAccess::Public, // Pass parameter types via a slice with TypeId's &[std::any::TypeId::of::<i64>(), std::any::TypeId::of::<bool>()], // Fixed closure signature |context, args| { // 'args' is guaranteed to be the right length and of the correct types // Get the second parameter by 'consuming' it let double = std::mem::take(args[1]).cast::<bool>(); // Since it is a primary type, it can also be cheaply copied let double = args[1].clone_cast::<bool>(); // Get a mutable reference to the first argument. let mut x = args[0].write_lock::<i64>().unwrap(); let orig = *x; if double { *x *= 2; // the first argument can be mutated } Ok(orig) // return Result<T, Box<EvalAltResult>> }); assert!(module.contains_fn(hash));
pub fn set_native_fn<ARGS, N, T, F>(&mut self, name: N, func: F) -> u64 where
N: AsRef<str> + Into<Identifier>,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
pub fn set_native_fn<ARGS, N, T, F>(&mut self, name: N, func: F) -> u64 where
N: AsRef<str> + Into<Identifier>,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
Set a Rust function into the Module
, returning a hash key.
If there is a similar existing Rust function, it is replaced.
Function Namespace
The default function namespace is FnNamespace::Internal
.
Use update_fn_namespace
to change it.
Function Metadata
No metadata for the function is registered.
Use update_fn_metadata
to add metadata.
Example
use rhai::Module; let mut module = Module::new(); let hash = module.set_native_fn("calc", || Ok(42_i64)); assert!(module.contains_fn(hash));
pub fn set_getter_fn<ARGS, A, T, F>(&mut self, name: &str, func: F) -> u64 where
A: Variant + Clone,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
F: Fn(&mut A) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
pub fn set_getter_fn<ARGS, A, T, F>(&mut self, name: &str, func: F) -> u64 where
A: Variant + Clone,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
F: Fn(&mut A) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
Set a Rust getter function taking one mutable parameter, returning a hash key. This function is automatically exposed to the global namespace.
If there is a similar existing Rust getter function, it is replaced.
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::Module; let mut module = Module::new(); let hash = module.set_getter_fn("value", |x: &mut i64| { Ok(*x) }); assert!(module.contains_fn(hash));
pub fn set_setter_fn<ARGS, A, B, F>(&mut self, name: &str, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<(), Box<EvalAltResult>>>,
F: Fn(&mut A, B) -> Result<(), Box<EvalAltResult>> + SendSync + 'static,
pub fn set_setter_fn<ARGS, A, B, F>(&mut self, name: &str, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<(), Box<EvalAltResult>>>,
F: Fn(&mut A, B) -> Result<(), Box<EvalAltResult>> + SendSync + 'static,
Set a Rust setter function taking two parameters (the first one mutable) into the Module
,
returning a hash key.
This function is automatically exposed to the global namespace.
If there is a similar existing setter Rust function, it is replaced.
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::{Module, ImmutableString}; let mut module = Module::new(); let hash = module.set_setter_fn("value", |x: &mut i64, y: ImmutableString| { *x = y.len() as i64; Ok(()) }); assert!(module.contains_fn(hash));
pub fn set_indexer_get_fn<ARGS, A, B, T, F>(&mut self, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
F: Fn(&mut A, B) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
pub fn set_indexer_get_fn<ARGS, A, B, T, F>(&mut self, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
T: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<T, Box<EvalAltResult>>>,
F: Fn(&mut A, B) -> Result<T, Box<EvalAltResult>> + SendSync + 'static,
Set a Rust index getter taking two parameters (the first one mutable) into the Module
,
returning a hash key.
This function is automatically exposed to the global namespace.
If there is a similar existing setter Rust function, it is replaced.
Panics
Panics if the type is Array
or Map
.
Indexers for arrays, object maps and strings cannot be registered.
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::{Module, ImmutableString}; let mut module = Module::new(); let hash = module.set_indexer_get_fn(|x: &mut i64, y: ImmutableString| { Ok(*x + y.len() as i64) }); assert!(module.contains_fn(hash));
pub fn set_indexer_set_fn<ARGS, A, B, C, F>(&mut self, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
C: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<(), Box<EvalAltResult>>>,
F: Fn(&mut A, B, C) -> Result<(), Box<EvalAltResult>> + SendSync + 'static,
pub fn set_indexer_set_fn<ARGS, A, B, C, F>(&mut self, func: F) -> u64 where
A: Variant + Clone,
B: Variant + Clone,
C: Variant + Clone,
F: RegisterNativeFunction<ARGS, Result<(), Box<EvalAltResult>>>,
F: Fn(&mut A, B, C) -> Result<(), Box<EvalAltResult>> + SendSync + 'static,
Set a Rust index setter taking three parameters (the first one mutable) into the Module
,
returning a hash key.
This function is automatically exposed to the global namespace.
If there is a similar existing Rust function, it is replaced.
Panics
Panics if the type is Array
or Map
.
Indexers for arrays, object maps and strings cannot be registered.
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::{Module, ImmutableString}; let mut module = Module::new(); let hash = module.set_indexer_set_fn(|x: &mut i64, y: ImmutableString, value: i64| { *x = y.len() as i64 + value; Ok(()) }); assert!(module.contains_fn(hash));
Set a pair of Rust index getter and setter functions, returning both hash keys.
This is a short-hand for set_indexer_get_fn
and
set_indexer_set_fn
.
If there are similar existing Rust functions, they are replaced.
Panics
Panics if the type is Array
or Map
.
Indexers for arrays, object maps and strings cannot be registered.
Function Metadata
No metadata for the function is registered. Use update_fn_metadata
to add metadata.
Example
use rhai::{Module, ImmutableString}; let mut module = Module::new(); let (hash_get, hash_set) = module.set_indexer_get_set_fn( |x: &mut i64, y: ImmutableString| { Ok(*x + y.len() as i64) }, |x: &mut i64, y: ImmutableString, value: i64| { *x = y.len() as i64 + value; Ok(()) } ); assert!(module.contains_fn(hash_get)); assert!(module.contains_fn(hash_set));
Does the particular namespace-qualified function exist in the Module
?
The u64
hash is calculated by build_index
.
Get the number of variables, functions and type iterators in the Module
.
Get an iterator to the sub-modules in the Module
.
Get an iterator to the variables in the Module
.
pub fn iter_script_fn_info(
&self
) -> impl Iterator<Item = (FnNamespace, FnAccess, &str, usize, &Shared<ScriptFnDef>)>
pub fn iter_script_fn_info(
&self
) -> impl Iterator<Item = (FnNamespace, FnAccess, &str, usize, &Shared<ScriptFnDef>)>
(INTERNALS) Get an iterator over all script-defined functions in the Module
.
Exported under the internals
feature only.
Function metadata includes:
- Namespace (
FnNamespace::Global
orFnNamespace::Internal
). - Access mode (
FnAccess::Public
orFnAccess::Private
). - Function name (as string slice).
- Number of parameters.
- (INTERNALS) Shared reference to function definition
ScriptFnDef
.
pub fn eval_ast_as_new(
scope: Scope<'_>,
ast: &AST,
engine: &Engine
) -> Result<Self, Box<EvalAltResult>>
pub fn eval_ast_as_new(
scope: Scope<'_>,
ast: &AST,
engine: &Engine
) -> Result<Self, Box<EvalAltResult>>
Create a new Module
by evaluating an AST
.
The entire AST
is encapsulated into each function, allowing functions
to cross-call each other. Functions in the global namespace, plus all functions
defined in the Module
, are merged into a unified namespace before each call.
Therefore, all functions will be found.
Example
use rhai::{Engine, Module, Scope}; let engine = Engine::new(); let ast = engine.compile("let answer = 42; export answer;")?; let module = Module::eval_ast_as_new(Scope::new(), &ast, &engine)?; assert!(module.contains_var("answer")); assert_eq!(module.get_var_value::<i64>("answer").unwrap(), 42);
Does the Module
contain indexed functions that have been exposed to the global namespace?
Panics
Panics if the Module
is not yet indexed via build_index
.
Does a type iterator exist in the entire module tree?
Does a type iterator exist in the module?
Set a type iterator into the Module
.
pub fn set_iterable<T>(&mut self) -> &mut Self where
T: Variant + Clone + IntoIterator,
<T as IntoIterator>::Item: Variant + Clone,
pub fn set_iterable<T>(&mut self) -> &mut Self where
T: Variant + Clone + IntoIterator,
<T as IntoIterator>::Item: Variant + Clone,
Set a type iterator into the Module
.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Module
impl !UnwindSafe for Module
Blanket Implementations
Mutably borrows from an owned value. Read more