Struct neon::context::ModuleContext

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

An execution context of module initialization.

Implementations

impl<'a> ModuleContext<'a>

pub fn export_function<T: Value>(
    &mut self,
    key: &str,
    f: fn(_: FunctionContext<'_>) -> JsResult<'_, T>
) -> NeonResult<()>

Convenience method for exporting a Neon function from a module.

pub fn export_class<T: Class>(&mut self, key: &str) -> NeonResult<()>

Convenience method for exporting a Neon class constructor from a module.

pub fn export_value<T: Value>(
    &mut self,
    key: &str,
    val: Handle<'_, T>
) -> NeonResult<()>

Exports a JavaScript value from a Neon module.

pub fn exports_object(&mut self) -> JsResult<'a, JsObject>

Produces a handle to a module’s exports object.

Trait Implementations

impl<'a> Context<'a> for ModuleContext<'a>

fn lock(&self) -> Lock<'_>

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

fn borrow<'c, V, T, F>(&self, v: &'c Handle<'_, V>, f: F) -> T where
    V: Value,
    &'c V: Borrow,
    F: for<'b> FnOnce(Ref<'b, <&'c V as Borrow>::Target>) -> T, 

Convenience method for locking the JavaScript engine and borrowing a single JS value’s internals.

fn borrow_mut<'c, V, T, F>(&self, v: &'c mut Handle<'_, V>, f: F) -> T where
    V: Value,
    &'c mut V: BorrowMut,
    F: for<'b> FnOnce(RefMut<'b, <&'c mut V as Borrow>::Target>) -> T, 

Convenience method for locking the JavaScript engine and mutably borrowing a single JS value’s internals.

fn execute_scoped<T, F>(&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>(&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>, 

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: u32) -> JsResult<'a, JsArrayBuffer>

Convenience method for creating an empty JsArrayBuffer value.

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

Convenience method for creating an empty JsBuffer 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.

impl<'a> UnwindSafe for ModuleContext<'a>