Struct rhai::FnPtr

pub struct FnPtr(_, _);

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

Implementations

impl FnPtr

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

Create a new function pointer.

pub fn fn_name(&self) -> &str

Get the name of the function.

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

Get the curried arguments.

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

Add a new curried argument.

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

Set curried arguments to the function pointer.

pub fn is_curried(&self) -> bool

Is the function pointer curried?

pub fn num_curried(&self) -> usize

Get the number of curried arguments.

pub fn is_anonymous(&self) -> bool

Does the function pointer refer to an anonymous function?

Not available under no_function.

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

Call the function pointer with curried arguments (if any).

If this function is a script-defined function, it must not be marked private.

WARNING

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

impl Clone for FnPtr

fn clone(&self) -> FnPtr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FnPtr

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

Formats the value using the given formatter.

impl Display for FnPtr

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

Formats the value using the given formatter.

impl From<FnPtr> for Dynamic

fn from(value: FnPtr) -> Self

Performs the conversion.

impl Hash for FnPtr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl TryFrom<&'_ str> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ImmutableString> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

fn try_from(value: ImmutableString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SmartString<Compact>> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

fn try_from(value: Identifier) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.