Struct rhai::NativeCallContext

pub struct NativeCallContext<'e, 'a, 'm, 'pm: 'm> { /* fields omitted */ }

Context of a native Rust function call.

Implementations

impl<'e, 'a, 'm, 'pm> NativeCallContext<'e, 'a, 'm, 'pm>

pub fn new(engine: &'e Engine, lib: &'m impl AsRef<[&'pm Module]>) -> Self

Create a new NativeCallContext.

pub fn new_with_imports(
    engine: &'e Engine,
    mods: &'a mut Imports,
    lib: &'m impl AsRef<[&'pm Module]>
) -> Self

(INTERNALS) Create a new NativeCallContext. Available under the internals feature only.

pub fn engine(&self) -> &'e Engine

The current Engine.

pub fn imports(&self) -> Option<&Imports>

(INTERNALS) The current set of modules imported via import statements. Available under the internals feature only.

pub fn iter_namespaces(&self) -> impl Iterator<Item = &'pm Module> + 'm

Get an iterator over the namespaces containing definition of all script-defined functions.

pub fn call_fn_dynamic_raw(
    &self,
    fn_name: &str,
    is_method: bool,
    public_only: bool,
    args: &mut [&mut Dynamic],
    def_value: Option<&Dynamic>
) -> Result<Dynamic, Box<EvalAltResult>>

Call a function inside the call context.

WARNING

All arguments may be consumed, meaning that they may be 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.

If is_method is true, the first argument is assumed to be passed by reference and is not consumed.

Trait Implementations

impl<'e, 'a, 'm, 'pm: 'm> Clone for NativeCallContext<'e, 'a, 'm, 'pm>

pub fn clone(&self) -> NativeCallContext<'e, 'a, 'm, 'pm>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'e, 'a, 'm, 'pm: 'm> Copy for NativeCallContext<'e, 'a, 'm, 'pm>

impl<'e, 'a, 'm, 'pm: 'm> Debug for NativeCallContext<'e, 'a, 'm, 'pm>

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

Formats the value using the given formatter.

impl<'e, 'a, 'm, 'pm: 'm, M: AsRef<[&'pm Module]> + ?Sized> From<(&'e Engine, &'a Imports, &'m M)> for NativeCallContext<'e, 'a, 'm, 'pm>

pub fn from(value: (&'e Engine, &'a Imports, &'m M)) -> Self

Performs the conversion.

impl<'e, 'm, 'pm: 'm, M: AsRef<[&'pm Module]> + ?Sized, '_> From<(&'e Engine, &'m M)> for NativeCallContext<'e, '_, 'm, 'pm>

pub fn from(value: (&'e Engine, &'m M)) -> Self

Performs the conversion.