Enum rhai::RhaiFunc

#[non_exhaustive]
pub enum RhaiFunc {
    Pure {
        func: Shared<dyn Fn(Option<NativeCallContext<'_>>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>,
        has_context: bool,
        is_pure: bool,
        is_volatile: bool,
    },
    Method {
        func: Shared<dyn Fn(Option<NativeCallContext<'_>>, &mut [&'_ mut Dynamic]) -> Result<Dynamic, Box<EvalAltResult>>>,
        has_context: bool,
        is_pure: bool,
        is_volatile: bool,
    },
    Iterator {
        func: Shared<dyn Fn(Dynamic) -> Box<dyn Iterator<Item = Result<Dynamic, Box<EvalAltResult>>>>>,
    },
    Plugin {
        func: Shared<dyn PluginFunc>,
    },
    Script {
        fn_def: Shared<ScriptFuncDef>,
        environ: Option<Shared<EncapsulatedEnviron>>,
    },
}

(internals) A type encapsulating a function callable by Rhai. Exported under the internals feature only.

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

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

Fields

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

Shared function pointer.

has_context: bool

Does the function take a NativeCallContext parameter?

is_pure: bool

This is a dummy field and is not used.

is_volatile: bool

Is this function volatile?

A volatile function does not guarantee the same result for the same input(s).

Method

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

Fields

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

Shared function pointer.

has_context: bool

Does the function take a NativeCallContext parameter?

is_pure: bool

Allow operating on constants?

is_volatile: bool

Is this function volatile?

A volatile function does not guarantee the same result for the same input(s).

Iterator

An iterator function.

Fields

func: Shared<dyn Fn(Dynamic) -> Box<dyn Iterator<Item = Result<Dynamic, Box<EvalAltResult>>>>>

Shared function pointer.

Plugin

A plugin function,

Fields

func: Shared<dyn PluginFunc>

Shared function pointer.

Script

A script-defined function.

Fields

fn_def: Shared<ScriptFuncDef>

Shared reference to the ScriptFuncDef function definition.

environ: Option<Shared<EncapsulatedEnviron>>

Encapsulated environment, if any.

Implementations

impl RhaiFunc

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 has_context(&self) -> bool

Is there a NativeCallContext parameter?

pub fn is_volatile(&self) -> bool

Is this function volatile?

A volatile function does not guarantee the same result for the same input(s).

pub fn access(&self) -> FnAccess

Get the access mode.

pub fn get_native_fn( &self ) -> Option<&Shared<dyn Fn(Option<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<ScriptFuncDef>>

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

Not available under no_function.

pub fn get_encapsulated_environ(&self) -> Option<&EncapsulatedEnviron>

Get a reference to the shared encapsulated environment of the function definition.

Not available under no_function or no_module.

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

Get a reference to an iterator function.

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

Get a shared reference to a plugin function.

Trait Implementations

impl Clone for RhaiFunc

fn clone(&self) -> RhaiFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RhaiFunc

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

Formats the value using the given formatter.

impl Display for RhaiFunc

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

Formats the value using the given formatter.

impl From<Rc<ScriptFuncDef>> for RhaiFunc

fn from(fn_def: Shared<ScriptFuncDef>) -> Self

Converts to this type from the input type.

impl From<Rc<dyn PluginFunc>> for RhaiFunc

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

Converts to this type from the input type.

impl From<ScriptFuncDef> for RhaiFunc

fn from(fn_def: ScriptFuncDef) -> Self

Converts to this type from the input type.

impl<T: PluginFunc + 'static + SendSync> From<T> for RhaiFunc

fn from(func: T) -> Self

Converts to this type from the input type.