Struct rhai::CallFnOptions
source · #[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,
}
Expand description
Options for calling a script-defined function via Engine::call_fn_with_options
.
Fields (Non-exhaustive)§
This struct is marked as 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§
source§impl<'a> CallFnOptions<'a>
impl<'a> CallFnOptions<'a>
sourcepub fn new() -> Self
pub fn new() -> Self
Create a default CallFnOptions
.
sourcepub fn bind_this_ptr(self, value: &'a mut Dynamic) -> Self
pub fn bind_this_ptr(self, value: &'a mut Dynamic) -> Self
Bind to the this
pointer.
sourcepub fn with_tag(self, value: impl Variant + Clone) -> Self
pub fn with_tag(self, value: impl Variant + Clone) -> Self
Set the custom state of this evaluation run (if any).
sourcepub const fn eval_ast(self, value: bool) -> Self
pub const fn eval_ast(self, value: bool) -> Self
Set whether to evaluate the AST
to load necessary modules before calling the function.
sourcepub const fn rewind_scope(self, value: bool) -> Self
pub const fn rewind_scope(self, value: bool) -> Self
Set whether to rewind the Scope
after the function call.
Trait Implementations§
source§impl<'t> Debug for CallFnOptions<'t>
impl<'t> Debug for CallFnOptions<'t>
source§impl Default for CallFnOptions<'_>
impl Default for CallFnOptions<'_>
Auto Trait Implementations§
impl<'t> Freeze for CallFnOptions<'t>
impl<'t> !RefUnwindSafe for CallFnOptions<'t>
impl<'t> !Send for CallFnOptions<'t>
impl<'t> !Sync for CallFnOptions<'t>
impl<'t> Unpin for CallFnOptions<'t>
impl<'t> !UnwindSafe for CallFnOptions<'t>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more