Enum rhai::plugin::CallableFunction

#[non_exhaustive]
pub enum CallableFunction {
    Pure(Shared<dyn Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>),
    Method(Shared<dyn Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>),
    Iterator(Shared<dyn Fn(Dynamic) -> Box<dyn Iterator<Item = Dynamic>>>),
    Plugin(Shared<dyn PluginFunction>),
    Script(Shared<ScriptFnDef>),
}

A type encapsulating a function callable by Rhai.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pure(Shared<dyn Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>)

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

Method(Shared<dyn Fn(NativeCallContext<'_>, &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(Shared<dyn Fn(Dynamic) -> Box<dyn Iterator<Item = Dynamic>>>)

An iterator function.

Plugin(Shared<dyn PluginFunction>)

A plugin function,

Script(Shared<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 const fn is_iter(&self) -> bool

Is this an iterator function?

pub const fn is_script(&self) -> bool

Is this a script-defined function?

pub const fn is_plugin_fn(&self) -> bool

Is this a plugin function?

pub const 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
) -> Option<&Shared<dyn Fn(NativeCallContext<'_>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>>

Get a shared reference to a native Rust function.

pub const fn get_script_fn_def(&self) -> Option<&Shared<ScriptFnDef>>

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

Not available under no_function.

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

Get a reference to an iterator function.

pub fn get_plugin_fn(&self) -> Option<&Shared<dyn PluginFunction>>

Get a shared reference to a plugin function.

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

Create a new CallableFunction::Pure.

pub fn from_method(
    func: Box<dyn Fn(NativeCallContext<'_>, &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: Shared<ScriptFnDef>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<ScriptFnDef> for CallableFunction

fn from(_func: ScriptFnDef) -> Self

Converts to this type from the input type.

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

fn from(func: T) -> Self

Converts to this type from the input type.