Struct nodex_api::scope::NapiHandleScope

pub struct NapiHandleScope(_, _);

Node-API provides the ability to establish a new ‘scope’ to which newly created handles will be associated. Once those handles are no longer required, the scope can be ‘closed’ and any handles associated with the scope are invalidated. The methods available to open/close scopes are napi_open_handle_scope and napi_close_handle_scope.

Node-API only supports a single nested hierarchy of scopes. There is only one active scope at any time, and all new handles will be associated with that scope while it is active. Scopes must be closed in the reverse order from which they are opened. In addition, all scopes created within a native method must be closed before returning from that method.

Implementations

impl NapiHandleScope

pub fn env(&self) -> NapiEnv

pub fn raw(&self) -> napi_handle_scope

pub fn open(env: NapiEnv) -> NapiResult<NapiHandleScope>

This API opens a new scope.

pub fn close(&mut self) -> NapiResult<()>

This API closes the scope passed in. Scopes must be closed in the reverse order from which they were created. This API can be called even if there is a pending JavaScript exception.

Trait Implementations

impl Clone for NapiHandleScope

fn clone(&self) -> NapiHandleScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NapiHandleScope

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

Formats the value using the given formatter.

impl Drop for NapiHandleScope

fn drop(&mut self)

Executes the destructor for this type.