Struct JsExternal

pub struct JsExternal<'env>(/* private fields */);

Represent the Node-API External value

The difference between the JsExternal and External is that the JsExternal holds the raw value of External. So that you can call Object::set_property with the JsExternal value, but can’t do the same with External.

Implementations

impl<'env> JsExternal<'env>

pub fn get_value<T: 'static>(&self) -> Result<&mut T>

Get the value from the JsExternal

If the underlying value is not T, it will return InvalidArg error.

pub fn create_ref<T: 'static>(&self) -> Result<ExternalRef<T>>

Create a reference to the JsExternal

If the underlying value is not T, it will return InvalidArg error.

Trait Implementations

impl<'env> FromNapiValue for JsExternal<'env>

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

Safety

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

impl<'env> JsValue<'env> for JsExternal<'env>

fn value(&self) -> Value

fn raw(&self) -> napi_value

fn to_unknown(&self) -> Unknown<'env>

Convert the value to an unknown

fn coerce_to_bool(&self) -> Result<bool>

Coerce the value to a boolean

fn coerce_to_number(&self) -> Result<JsNumber<'_>>

fn coerce_to_string(&self) -> Result<JsString<'_>>

fn coerce_to_object(&self) -> Result<Object<'env>>

fn is_date(&self) -> Result<bool>

fn is_promise(&self) -> Result<bool>

fn is_error(&self) -> Result<bool>

fn is_typedarray(&self) -> Result<bool>

fn is_dataview(&self) -> Result<bool>

fn is_array(&self) -> Result<bool>

fn is_buffer(&self) -> Result<bool>

fn is_arraybuffer(&self) -> Result<bool>

fn instanceof<'c, Constructor>(&self, constructor: Constructor) -> Result<bool>

where Constructor: JsValue<'c>,

fn escape<'scope, E: JsValue<'scope> + FromNapiValue>( &self, escapable_handle_scope: EscapableHandleScope<'scope>, ) -> Result<E>

impl<'env> TypeName for JsExternal<'env>

fn type_name() -> &'static str

fn value_type() -> ValueType

impl<'env> ValidateNapiValue for JsExternal<'env>

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

Safety