Struct rhai::CallFnOptions

#[non_exhaustive]
pub struct CallFnOptions<'t> {
    pub this_ptr: Option<&'t mut Dynamic>,
    pub tag: Option<Dynamic>,
    pub eval_ast: bool,
    pub rewind_scope: bool,
}

Options for calling a script-defined function via Engine::call_fn_with_options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

this_ptr: Option<&'t mut Dynamic>

A value for binding to the this pointer (if any). Default None.

tag: Option<Dynamic>

The custom state of this evaluation run (if any), overrides Engine::default_tag. Default None.

eval_ast: bool

Evaluate the AST to load necessary modules before calling the function? Default true.

rewind_scope: bool

Rewind the Scope after the function call? Default true.

Implementations

impl<'a> CallFnOptions<'a>

pub fn new() -> Self

Create a default CallFnOptions.

pub fn bind_this_ptr(self, value: &'a mut Dynamic) -> Self

Bind to the this pointer.

pub fn with_tag(self, value: impl Variant + Clone) -> Self

Set the custom state of this evaluation run (if any).

pub const fn eval_ast(self, value: bool) -> Self

Set whether to evaluate the AST to load necessary modules before calling the function.

pub const fn rewind_scope(self, value: bool) -> Self

Set whether to rewind the Scope after the function call.

Trait Implementations

impl<'t> Debug for CallFnOptions<'t>

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

Formats the value using the given formatter.

impl Default for CallFnOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'t> Hash for CallFnOptions<'t>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.