Struct ObjectRef

pub struct ObjectRef<const LEAK_CHECK: bool = true> { /* private fields */ }

A reference to a JavaScript object.

You must call the unref method to release the reference, or the object under the hood will be leaked forever.

Set the LEAK_CHECK to false to disable the leak check during the Drop

Implementations

impl<const LEAK_CHECK: bool> ObjectRef<LEAK_CHECK>

pub fn get_value<'env>(&self, env: &'env Env) -> Result<Object<'env>>

Get the object from the reference

pub fn unref(self, env: &Env) -> Result<()>

Unref the reference

Trait Implementations

impl<const LEAK_CHECK: bool> Drop for ObjectRef<LEAK_CHECK>

fn drop(&mut self)

Executes the destructor for this type.

impl<const LEAK_CHECK: bool> FromNapiValue for ObjectRef<LEAK_CHECK>

unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> Result<Self>

Safety

fn from_unknown(value: Unknown<'_>) -> Result<Self>

impl<const LEAK_CHECK: bool> ToNapiValue for &ObjectRef<LEAK_CHECK>

unsafe fn to_napi_value(env: napi_env, val: Self) -> Result<napi_value>

Safety

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>>

impl<const LEAK_CHECK: bool> ToNapiValue for ObjectRef<LEAK_CHECK>

unsafe fn to_napi_value(env: napi_env, val: Self) -> Result<napi_value>

Safety

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>>

impl<const LEAK_CHECK: bool> Send for ObjectRef<LEAK_CHECK>