Struct rune::compile::Module [−][src]
pub struct Module { /* fields omitted */ }
Expand description
A Module that is a collection of native functions and types.
Needs to be installed into a Context using Context::install.
Implementations
Construct a new module for the given item.
Construct a new module for the given crate.
pub fn with_crate_item<I>(name: &str, iter: I) -> Self where
I: IntoIterator,
I::Item: IntoComponent,
pub fn with_crate_item<I>(name: &str, iter: I) -> Self where
I: IntoIterator,
I::Item: IntoComponent,
Construct a new module for the given crate.
Register a type. Registering a type is mandatory in order to register instance functions using that type.
This will allow the type to be used within scripts, using the item named here.
Examples
use rune::Any;
#[derive(Any)]
struct MyBytes {
queue: Vec<String>,
}
impl MyBytes {
fn len(&self) -> usize {
self.queue.len()
}
}
// Register `len` without registering a type.
let mut module = rune::Module::default();
// Note: cannot do this until we have registered a type.
module.inst_fn("len", MyBytes::len)?;
let mut context = rune::Context::new();
assert!(context.install(&module).is_err());
// Register `len` properly.
let mut module = rune::Module::default();
module.ty::<MyBytes>()?;
module.inst_fn("len", MyBytes::len)?;
let mut context = rune::Context::new();
assert!(context.install(&module).is_ok());
Construct type information for the unit
type.
Registering this allows the given type to be used in Rune scripts when
referring to the unit
type.
Examples
This shows how to register the unit type ()
as nonstd::unit
.
use rune::Module;
let mut module = Module::with_item(&["nonstd"]);
module.unit("unit")?;
pub fn option<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
pub fn option<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
Construct type information for the Option
type.
Registering this allows the given type to be used in Rune scripts when
referring to the Option
type.
Examples
This shows how to register the Option
as nonstd::option::Option
.
use rune::Module;
let mut module = Module::with_crate_item("nonstd", &["option"]);
module.option(&["Option"])?;
pub fn result<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
pub fn result<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
Construct type information for the internal Result
type.
Registering this allows the given type to be used in Rune scripts when
referring to the Result
type.
Examples
This shows how to register the Result
as nonstd::result::Result
.
use rune::Module;
let mut module = Module::with_crate_item("nonstd", &["result"]);
module.result(&["Result"])?;
pub fn generator_state<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
pub fn generator_state<N>(&mut self, name: N) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
Construct the type information for the GeneratorState
type.
Registering this allows the given type to be used in Rune scripts when
referring to the GeneratorState
type.
Examples
This shows how to register the GeneratorState
as
nonstd::generator::GeneratorState
.
use rune::Module;
let mut module = Module::with_crate_item("nonstd", &["generator"]);
module.generator_state(&["GeneratorState"])?;
pub fn function<Func, Args, N>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
Func: Function<Args>,
N: IntoIterator,
N::Item: IntoComponent,
pub fn function<Func, Args, N>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
Func: Function<Args>,
N: IntoIterator,
N::Item: IntoComponent,
Register a function that cannot error internally.
Examples
fn add_ten(value: i64) -> i64 {
value + 10
}
let mut module = rune::Module::default();
module.function(&["add_ten"], add_ten)?;
module.function(&["empty"], || Ok::<_, rune::Error>(()))?;
module.function(&["string"], |a: String| Ok::<_, rune::Error>(()))?;
module.function(&["optional"], |a: Option<String>| Ok::<_, rune::Error>(()))?;
pub fn constant<N, V>(&mut self, name: N, value: V) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
V: ToValue,
pub fn constant<N, V>(&mut self, name: N, value: V) -> Result<(), ContextError> where
N: IntoIterator,
N::Item: IntoComponent,
V: ToValue,
Register a constant value, at a crate, module or associated level.
Examples
let mut module = rune::Module::default();
module.constant(&["TEN"], 10)?; // a global TEN value
module.constant(&["MyType", "TEN"], 10)?; // looks like an associated value
pub fn macro_<N, M>(&mut self, name: N, f: M) -> Result<(), ContextError> where
M: 'static + Send + Sync + Fn(&mut MacroContext<'_>, &TokenStream) -> Result<TokenStream>,
N: IntoIterator,
N::Item: IntoComponent,
pub fn macro_<N, M>(&mut self, name: N, f: M) -> Result<(), ContextError> where
M: 'static + Send + Sync + Fn(&mut MacroContext<'_>, &TokenStream) -> Result<TokenStream>,
N: IntoIterator,
N::Item: IntoComponent,
Register a native macro handler.
pub fn async_function<Func, Args, N>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
Func: AsyncFunction<Args>,
N: IntoIterator,
N::Item: IntoComponent,
pub fn async_function<Func, Args, N>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
Func: AsyncFunction<Args>,
N: IntoIterator,
N::Item: IntoComponent,
Register a function.
Examples
let mut module = rune::Module::default();
module.async_function(&["empty"], || async { () })?;
module.async_function(&["empty_fallible"], || async { Ok::<_, rune::Error>(()) })?;
module.async_function(&["string"], |a: String| async { Ok::<_, rune::Error>(()) })?;
module.async_function(&["optional"], |a: Option<String>| async { Ok::<_, rune::Error>(()) })?;
Register a raw function which interacts directly with the virtual machine.
pub fn inst_fn<N, Func, Args>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: InstFn<Args>,
pub fn inst_fn<N, Func, Args>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: InstFn<Args>,
Register an instance function.
Examples
use rune::Any;
#[derive(Any)]
struct MyBytes {
queue: Vec<String>,
}
impl MyBytes {
fn new() -> Self {
Self {
queue: Vec::new(),
}
}
fn len(&self) -> usize {
self.queue.len()
}
}
let mut module = rune::Module::default();
module.ty::<MyBytes>()?;
module.function(&["MyBytes", "new"], MyBytes::new)?;
module.inst_fn("len", MyBytes::len)?;
let mut context = rune::Context::new();
context.install(&module)?;
pub fn field_fn<N, Func, Args>(
&mut self,
protocol: Protocol,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: InstFn<Args>,
pub fn field_fn<N, Func, Args>(
&mut self,
protocol: Protocol,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: InstFn<Args>,
Install a protocol function for the given field.
pub fn async_inst_fn<N, Func, Args>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: AsyncInstFn<Args>,
pub fn async_inst_fn<N, Func, Args>(
&mut self,
name: N,
f: Func
) -> Result<(), ContextError> where
N: InstFnNameHash,
Func: AsyncInstFn<Args>,
Register an instance function.
Examples
use std::sync::atomic::AtomicU32;
use std::sync::Arc;
use rune::Any;
#[derive(Clone, Debug, Any)]
struct MyType {
value: Arc<AtomicU32>,
}
impl MyType {
async fn test(&self) -> rune::Result<()> {
Ok(())
}
}
let mut module = rune::Module::default();
module.ty::<MyType>()?;
module.async_inst_fn("test", MyType::test)?;