Enum rhai::plugin::CallableFunction

pub enum CallableFunction {
    Pure(Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>),
    Method(Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>),
    Iterator(fn(_: Dynamic) -> Box<dyn Iterator<Item = Dynamic>>),
    Plugin(Rc<dyn PluginFunction>),
    Script(Rc<ScriptFnDef>),
}

A type encapsulating a function callable by Rhai.

Variants

Pure(Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>)

Tuple Fields

0: Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>

A pure native Rust function with all arguments passed by value.

Method(Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>)

Tuple Fields

0: Rc<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>

A native Rust object method with the first argument passed by reference, and the rest passed by value.

Iterator(fn(_: Dynamic) -> Box<dyn Iterator<Item = Dynamic>>)

Tuple Fields

0: fn(_: Dynamic) -> Box<dyn Iterator<Item = Dynamic>>

An iterator function.

Plugin(Rc<dyn PluginFunction>)

Tuple Fields

0: Rc<dyn PluginFunction>

A plugin function,

Script(Rc<ScriptFnDef>)

Tuple Fields

0: Rc<ScriptFnDef>

A script-defined function.

Implementations

impl CallableFunction

pub fn is_pure(&self) -> bool

Is this a pure native Rust function?

pub fn is_method(&self) -> bool

Is this a native Rust method function?

pub fn is_iter(&self) -> bool

Is this an iterator function?

pub fn is_script(&self) -> bool

Is this a Rhai-scripted function?

pub fn is_plugin_fn(&self) -> bool

Is this a plugin function?

pub fn is_native(&self) -> bool

Is this a native Rust function?

pub fn access(&self) -> FnAccess

Get the access mode.

pub fn get_native_fn(
    &self
) -> &dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>

Get a reference to a native Rust function.

Panics

Panics if the CallableFunction is not Pure or Method.

pub fn get_shared_fn_def(&self) -> &Rc<ScriptFnDef>

Get a shared reference to a script-defined function definition.

Panics

Panics if the CallableFunction is not Script.

pub fn get_fn_def(&self) -> &ScriptFnDef

Get a reference to a script-defined function definition.

Panics

Panics if the CallableFunction is not Script.

pub fn get_iter_fn(&self) -> fn(_: Dynamic) -> Box<dyn Iterator<Item = Dynamic>>

Get a reference to an iterator function.

Panics

Panics if the CallableFunction is not Iterator.

pub fn get_plugin_fn<'s>(&'s self) -> &dyn PluginFunction

Get a reference to a plugin function.

Panics

Panics if the CallableFunction is not Plugin.

pub fn from_pure(
    func: Box<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>
) -> Self

Create a new CallableFunction::Pure.

pub fn from_method(
    func: Box<dyn Fn(&Engine, &Module, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>
) -> Self

Create a new CallableFunction::Method.

pub fn from_plugin(func: impl PluginFunction + 'static + SendSync) -> Self

Create a new CallableFunction::Plugin.

Trait Implementations

impl Clone for CallableFunction

fn clone(&self) -> CallableFunction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CallableFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CallableFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Rc<ScriptFnDef>> for CallableFunction

fn from(_func: Rc<ScriptFnDef>) -> Self

Performs the conversion.

impl From<Rc<dyn PluginFunction + 'static>> for CallableFunction

fn from(func: Rc<dyn PluginFunction>) -> Self

Performs the conversion.

impl From<ScriptFnDef> for CallableFunction

fn from(_func: ScriptFnDef) -> Self

Performs the conversion.

impl<T: PluginFunction + 'static + SendSync> From<T> for CallableFunction

fn from(func: T) -> Self

Performs the conversion.

impl From<fn(Dynamic) -> Box<dyn Iterator<Item = Dynamic> + 'static, Global>> for CallableFunction

fn from(func: fn(_: Dynamic) -> Box<dyn Iterator<Item = Dynamic>>) -> Self

Performs the conversion.