pub struct FnPtr { /* private fields */ }
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
sourceimpl FnPtr
impl FnPtr
sourcepub fn num_curried(&self) -> usize
👎Deprecated since 1.8.0: use curry().len()
instead
pub fn num_curried(&self) -> usize
use curry().len()
instead
Get the number of curried arguments.
Deprecated
This method is deprecated. Use curry().len()
instead.
This method will be removed in the next major version.
sourcepub 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
pub fn call_dynamic(
&self,
context: &NativeCallContext<'_>,
this_ptr: Option<&mut Dynamic>,
arg_values: impl AsMut<[Dynamic]>
) -> Result<Dynamic, Box<EvalAltResult>>
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.
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.
sourceimpl FnPtr
impl FnPtr
sourcepub fn new(name: impl Into<Identifier>) -> Result<Self, Box<EvalAltResult>>
pub fn new(name: impl Into<Identifier>) -> Result<Self, Box<EvalAltResult>>
Create a new function pointer.
sourcepub fn set_curry(
&mut self,
values: impl IntoIterator<Item = Dynamic>
) -> &mut Self
pub fn set_curry(
&mut self,
values: impl IntoIterator<Item = Dynamic>
) -> &mut Self
Set curried arguments to the function pointer.
sourcepub fn is_curried(&self) -> bool
pub fn is_curried(&self) -> bool
Is the function pointer curried?
sourcepub fn is_anonymous(&self) -> bool
pub fn is_anonymous(&self) -> bool
Does the function pointer refer to an anonymous function?
Not available under no_function
.
sourcepub fn call<T: Variant + Clone>(
&self,
engine: &Engine,
ast: &AST,
args: impl FuncArgs
) -> Result<T, Box<EvalAltResult>>
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 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);
sourcepub fn call_within_context<T: Variant + Clone>(
&self,
context: &NativeCallContext<'_>,
args: impl FuncArgs
) -> Result<T, Box<EvalAltResult>>
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.
sourcepub fn call_raw(
&self,
context: &NativeCallContext<'_>,
this_ptr: Option<&mut Dynamic>,
arg_values: impl AsMut<[Dynamic]>
) -> Result<Dynamic, Box<EvalAltResult>>
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.
Trait Implementations
sourceimpl TryFrom<&str> for FnPtr
impl TryFrom<&str> for FnPtr
type Error = Box<EvalAltResult, Global>
type Error = Box<EvalAltResult, Global>
The type returned in the event of a conversion error.
sourceimpl TryFrom<ImmutableString> for FnPtr
impl TryFrom<ImmutableString> for FnPtr
type Error = Box<EvalAltResult, Global>
type Error = Box<EvalAltResult, Global>
The type returned in the event of a conversion error.
sourcefn try_from(value: ImmutableString) -> Result<Self, Box<EvalAltResult>>
fn try_from(value: ImmutableString) -> Result<Self, Box<EvalAltResult>>
Performs the conversion.
sourceimpl TryFrom<SmartString<LazyCompact>> for FnPtr
impl TryFrom<SmartString<LazyCompact>> for FnPtr
type Error = Box<EvalAltResult, Global>
type Error = Box<EvalAltResult, Global>
The type returned in the event of a conversion error.
sourcefn try_from(value: Identifier) -> Result<Self, Box<EvalAltResult>>
fn try_from(value: Identifier) -> Result<Self, Box<EvalAltResult>>
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for FnPtr
impl !Send for FnPtr
impl !Sync for FnPtr
impl Unpin for FnPtr
impl !UnwindSafe for FnPtr
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more