Struct quad_compat_rhai::NativeCallContext

pub struct NativeCallContext<'a> { /* fields omitted */ }

Context of a native Rust function call.

Implementations

impl NativeCallContext<'_>

pub fn call_fn_dynamic_raw(
    &self,
    fn_name: impl AsRef<str>,
    is_method_call: bool,
    args: &mut [&mut Dynamic]
) -> Result<Dynamic, Box<EvalAltResult>>

👎 Deprecated since 1.2.0:

use call_fn_raw instead

Call a function inside the call context.

WARNING - Low Level API

This function is very low level.

Arguments

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.

Deprecated

This method is deprecated. Use call_fn_raw instead.

This method will be removed in the next major version.

impl<'a> NativeCallContext<'a>

pub fn new(
    engine: &'a Engine,
    fn_name: &'a impl AsRef<str> + 'a + ?Sized,
    lib: &'a [&Module]
) -> Self

👎 Deprecated since 1.3.0:

NativeCallContext::new will be moved under internals. Use FnPtr::call to call a function pointer directly.

(internals) Create a new NativeCallContext. Exported under the metadata feature only.

pub fn new_with_all_fields(
    engine: &'a Engine,
    fn_name: &'a impl AsRef<str> + 'a + ?Sized,
    source: Option<&'a impl AsRef<str> + 'a + ?Sized>,
    imports: &'a Imports,
    lib: &'a [&Module],
    pos: Position
) -> Self

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

Not available under no_module.

pub const fn engine(&self) -> &Engine

The current Engine.

pub const fn fn_name(&self) -> &str

Name of the function called.

pub const fn position(&self) -> Position

Position of the function call.

pub const fn source(&self) -> Option<&str>

The current source.

pub fn iter_imports(&self) -> impl Iterator<Item = (&str, &Module)>

Get an iterator over the current set of modules imported via import statements.

Not available under no_module.

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

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

Not available under no_module.

pub fn iter_namespaces(&self) -> impl Iterator<Item = &Module>

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

pub const fn namespaces(&self) -> &[&Module]

(internals) The current set of namespaces containing definitions of all script-defined functions. Exported under the internals feature only.

pub fn call_fn_raw(
    &self,
    fn_name: impl AsRef<str>,
    is_ref_mut: bool,
    is_method_call: bool,
    args: &mut [&mut Dynamic]
) -> Result<Dynamic, Box<EvalAltResult>>

Call a function inside the call context.

If is_method_call is true, the first argument is assumed to be the this pointer for a script-defined function (or the object of a method call).

WARNING - Low Level API

This function is very low level.

Arguments

All arguments may be consumed, meaning that they may be replaced by (). This is to avoid unnecessarily cloning the arguments.

DO NOT reuse the arguments after this call. If they are needed afterwards, clone them before calling this function.

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

Trait Implementations

impl<'a> Debug for NativeCallContext<'a>

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

Formats the value using the given formatter.

impl<'a, M: AsRef<[&'a Module]> + ?Sized, S: AsRef<str> + 'a + ?Sized> From<(&'a Engine, &'a S, &'a M)> for NativeCallContext<'a>

fn from(value: (&'a Engine, &'a S, &'a M)) -> Self

Performs the conversion.

impl<'a, M: AsRef<[&'a Module]> + ?Sized, S: AsRef<str> + 'a + ?Sized> From<(&'a Engine, &'a S, Option<&'a S>, &'a Imports, &'a M, Position)> for NativeCallContext<'a>

fn from(
    value: (&'a Engine, &'a S, Option<&'a S>, &'a Imports, &'a M, Position)
) -> Self

Performs the conversion.