Trait nj_core::JSClass

source ·
pub trait JSClass: Sized {
    const CLASS_NAME: &'static str;

    // Required methods
    fn create_from_js(
        js_env: &JsEnv,
        cb: napi_callback_info
    ) -> Result<(Self, JsCallback), NjError>;
    fn set_constructor(constructor: napi_ref);
    fn get_constructor() -> napi_ref;

    // Provided methods
    fn new_instance(
        js_env: &JsEnv,
        js_args: Vec<napi_value>
    ) -> Result<napi_value, NjError> { ... }
    fn unwrap_mut(
        js_env: &JsEnv,
        instance: napi_value
    ) -> Result<&'static mut Self, NjError> { ... }
    fn unwrap(
        js_env: &JsEnv,
        instance: napi_value
    ) -> Result<&'static Self, NjError> { ... }
    fn properties() -> PropertiesBuilder { ... }
    fn js_init(js_exports: &mut JsExports) -> Result<(), NjError> { ... }
    extern "C" fn js_new(
        env: napi_env,
        info: napi_callback_info
    ) -> napi_value { ... }
    extern "C" fn js_finalize(
        _env: napi_env,
        finalize_data: *mut c_void,
        _finalize_hint: *mut c_void
    ) { ... }
}

Required Associated Constants§

source

const CLASS_NAME: &'static str

Required Methods§

Provided Methods§

source

fn new_instance( js_env: &JsEnv, js_args: Vec<napi_value> ) -> Result<napi_value, NjError>

new instance

source

fn unwrap_mut( js_env: &JsEnv, instance: napi_value ) -> Result<&'static mut Self, NjError>

given instance, return my object

source

fn unwrap( js_env: &JsEnv, instance: napi_value ) -> Result<&'static Self, NjError>

source

fn properties() -> PropertiesBuilder

source

fn js_init(js_exports: &mut JsExports) -> Result<(), NjError>

define class and properties under exports

source

extern "C" fn js_new( env: napi_env, info: napi_callback_info ) -> napi_value

call when Javascript class constructor is called For example: new Car(…)

source

extern "C" fn js_finalize( _env: napi_env, finalize_data: *mut c_void, _finalize_hint: *mut c_void )

Implementors§