Struct quad_compat_rhai::FnPtr[−][src]

pub struct FnPtr(_, _);

Expand description

A general function pointer, which may carry additional (i.e. curried) argument values to be passed onto a function during a call.

Implementations

[src]

impl FnPtr

[src]

pub fn call_dynamic(
 &self,
 context: &NativeCallContext<'_>,
 this_ptr: Option<&mut Dynamic>,
 arg_values: impl AsMut<[Dynamic ]>
) -> Result<Dynamic, Box<EvalAltResult>>

👎 Deprecated since 1.3.0:

use call_within_context or call_raw instead

Call the function pointer with curried arguments (if any). The function may be script-defined (not available under no_function) or native Rust.

This method is intended for calling a function pointer that is passed into a native Rust function as an argument. Therefore, the AST is NOT evaluated before calling the function.

Deprecated

This method is deprecated. Use call_within_context or call_raw instead.

This method will be removed in the next major version.

All the arguments are consumed, meaning that they’re replaced by (). This is to avoid unnecessarily cloning the arguments. Do not use the arguments after this call. If they are needed afterwards, clone them before calling this function.

[src]

impl FnPtr

[src]

pub fn new(name: impl Into<Identifier>) -> Result<Self, Box<EvalAltResult>>

Create a new function pointer.

[src]

pub fn fn_name(&self) -> &str

Get the name of the function.

[src]

pub fn curry(&self) -> &[Dynamic ]

Get the curried arguments.

[src]

pub fn add_curry(&mut self, value: Dynamic) -> &mut Self

Add a new curried argument.

[src]

pub fn set_curry(
&mut self,
values: impl IntoIterator<Item = Dynamic>
) -> &mut Self

Set curried arguments to the function pointer.

[src]

pub fn is_curried(&self) -> bool

Is the function pointer curried?

[src]

pub fn num_curried(&self) -> usize

Get the number of curried arguments.

[src]

pub fn is_anonymous(&self) -> bool

Does the function pointer refer to an anonymous function?

Not available under no_function.

[src]

pub fn call<T: Variant + Clone>(
 &self,
 engine: &Engine,
 ast: &AST,
 args: impl FuncArgs
) -> Result<T, Box<EvalAltResult>>

Call the function pointer with curried arguments (if any). The function may be script-defined (not available under no_function) or native Rust.

This method is intended for calling a function pointer directly, possibly on another Engine. Therefore, the AST is NOT evaluated before calling the function.

Example

use quad_compat_rhai::{Engine, FnPtr};

let engine = Engine::new();

let ast = engine.compile("fn foo(x, y) { len(x) + y }")?;

let mut fn_ptr = FnPtr::new("foo")?;

// Curry values into the function pointer
fn_ptr.set_curry(vec!["abc".into()]);

// Values are only needed for non-curried parameters
let result: i64 = fn_ptr.call(&engine, &ast, ( 39_i64, ) )?;

assert_eq!(result, 42);

[src]

pub fn call_within_context<T: Variant + Clone>(
 &self,
 context: &NativeCallContext<'_>,
 args: impl FuncArgs
) -> Result<T, Box<EvalAltResult>>

Call the function pointer with curried arguments (if any). The function may be script-defined (not available under no_function) or native Rust.

This method is intended for calling a function pointer that is passed into a native Rust function as an argument. Therefore, the AST is NOT evaluated before calling the function.

[src]

pub fn call_raw(
 &self,
 context: &NativeCallContext<'_>,
 this_ptr: Option<&mut Dynamic>,
 arg_values: impl AsMut<[Dynamic ]>
) -> Result<Dynamic, Box<EvalAltResult>>

Call the function pointer with curried arguments (if any). The function may be script-defined (not available under no_function) or native Rust.

This method is intended for calling a function pointer that is passed into a native Rust function as an argument. Therefore, the AST is NOT evaluated before calling the function.

WARNING - Low Level API

This function is very low level.

Arguments

All the arguments are consumed, meaning that they’re replaced by (). This is to avoid unnecessarily cloning the arguments. Do not use the arguments after this call. If they are needed afterwards, clone them before calling this function.