Struct neon::context::CallContext

pub struct CallContext<'a, T: This> { /* fields omitted */ }

An execution context of a function call.

The type parameter T is the type of the this-binding.

Implementations

impl<'a, T: This> CallContext<'a, T>

pub fn kind(&self) -> CallKind

Indicates whether the function was called with new.

pub fn len(&self) -> i32

Indicates the number of arguments that were passed to the function.

pub fn is_empty(&self) -> bool

Indicates if no arguments were passed to the function.

pub fn argument_opt(&mut self, i: i32) -> Option<Handle<'a, JsValue>>

Produces the ith argument, or None if i is greater than or equal to self.len().

pub fn argument<V: Value>(&mut self, i: i32) -> JsResult<'a, V>

Produces the ith argument and casts it to the type V, or throws an exception if i is greater than or equal to self.len() or cannot be cast to V.

pub fn this(&mut self) -> Handle<'a, T>

Produces a handle to the this-binding.

Trait Implementations

impl<'a, T: This> Context<'a> for CallContext<'a, T>

fn lock<'b>(&'b mut self) -> Lock<'_, Self> where
    'a: 'b, 

Lock the JavaScript engine, returning an RAII guard that keeps the lock active as long as the guard is alive.

fn execute_scoped<T, F>(&mut self, f: F) -> T where
    F: for<'b> FnOnce(ExecuteContext<'b>) -> T, 

Executes a computation in a new memory management scope.

fn compute_scoped<V, F>(&mut self, f: F) -> JsResult<'a, V> where
    V: Value,
    F: for<'b, 'c> FnOnce(ComputeContext<'b, 'c>) -> JsResult<'b, V>, 

Executes a computation in a new memory management scope and computes a single result value that outlives the computation.

fn try_catch<T, F>(&mut self, f: F) -> Result<T, Handle<'a, JsValue>> where
    F: FnOnce(&mut Self) -> NeonResult<T>, 

This is supported on crate feature try-catch-api only.

fn boolean(&mut self, b: bool) -> Handle<'a, JsBoolean>

Convenience method for creating a JsBoolean value.

fn number<T: Into<f64>>(&mut self, x: T) -> Handle<'a, JsNumber>

Convenience method for creating a JsNumber value.

fn string<S: AsRef<str>>(&mut self, s: S) -> Handle<'a, JsString>

Convenience method for creating a JsString value.

fn try_string<S: AsRef<str>>(&mut self, s: S) -> StringResult<'a>

Convenience method for creating a JsString value.

fn null(&mut self) -> Handle<'a, JsNull>

Convenience method for creating a JsNull value.

fn undefined(&mut self) -> Handle<'a, JsUndefined>

Convenience method for creating a JsUndefined value.

fn empty_object(&mut self) -> Handle<'a, JsObject>

Convenience method for creating an empty JsObject value.

fn empty_array(&mut self) -> Handle<'a, JsArray>

Convenience method for creating an empty JsArray value.

fn array_buffer(&mut self, size: usize) -> JsResult<'a, JsArrayBuffer>

Convenience method for creating an empty JsArrayBuffer value.

fn buffer(&mut self, size: usize) -> JsResult<'a, JsBuffer>

Convenience method for creating an empty JsBuffer value.

fn date(
    &mut self,
    value: impl Into<f64>
) -> Result<Handle<'a, JsDate>, DateError>

This is supported on crate feature napi-5 only.

Convenience method for creating a JsDate value.

fn global(&mut self) -> Handle<'a, JsObject>

Produces a handle to the JavaScript global object.

fn throw<T: Value, U>(&mut self, v: Handle<'_, T>) -> NeonResult<U>

Throws a JS value.

fn error<S: AsRef<str>>(&mut self, msg: S) -> JsResult<'a, JsError>

Creates a direct instance of the Error class.

fn type_error<S: AsRef<str>>(&mut self, msg: S) -> JsResult<'a, JsError>

Creates an instance of the TypeError class.

fn range_error<S: AsRef<str>>(&mut self, msg: S) -> JsResult<'a, JsError>

Creates an instance of the RangeError class.

fn throw_error<S: AsRef<str>, T>(&mut self, msg: S) -> NeonResult<T>

Throws a direct instance of the Error class.

fn throw_type_error<S: AsRef<str>, T>(&mut self, msg: S) -> NeonResult<T>

Throws an instance of the TypeError class.

fn throw_range_error<S: AsRef<str>, T>(&mut self, msg: S) -> NeonResult<T>

Throws an instance of the RangeError class.

fn boxed<U: Finalize + Send + 'static>(&mut self, v: U) -> Handle<'a, JsBox<U>>

Convenience method for wrapping a value in a JsBox.

fn channel(&mut self) -> Channel

This is supported on crate features napi-4 and channel-api only.

Returns an unbounded channel for scheduling events to be executed on the JavaScript thread.

impl<'a, T: This> UnwindSafe for CallContext<'a, T>