Struct External 

#[repr(C)]
pub struct External<T: 'static> {
    pub adjusted_size: i64,
    /* private fields */
}

Fields

adjusted_size: i64

Implementations

impl<T: 'static> External<T>

pub fn new(value: T) -> Self

pub unsafe fn inner_from_raw_mut( unknown_tagged_object: *mut c_void, ) -> Option<&'static mut T>

Turn a raw pointer (from napi) pointing to an External into a mutable reference to the inner object.

Safety

The unknown_tagged_object raw pointer must point to an External<T> struct.

pub unsafe fn inner_from_raw( unknown_tagged_object: *mut c_void, ) -> Option<&'static T>

Turn a raw pointer (from napi) pointing to an External into a reference inner object.

Safety

The unknown_tagged_object raw pointer must point to an External<T> struct.

pub fn new_with_size_hint(value: T, size_hint: usize) -> Self

size_hint is a value to tell Node.js GC how much memory is used by this External object.

If getting the exact size_hint is difficult, you can provide an approximate value, it’s only effect to the GC.

If your External object is not effect to GC, you can use External::new instead.

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

convert External<T> to Unknown

pub fn into_js_external(self, env: &Env) -> Result<JsExternal<'_>>

Convert External<T> to JsExternal

Trait Implementations

impl<T: 'static> AsMut<T> for External<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: 'static> AsRef<T> for External<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: 'static> Deref for External<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: 'static> DerefMut for External<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: 'static> From<T> for External<T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T: 'static> FromNapiMutRef for External<T>

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety

impl<T: 'static> FromNapiRef for External<T>

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety

impl<T: 'static> ToNapiValue for External<T>

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

Safety

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

impl<T: 'static> TypeName for &External<T>

fn type_name() -> &'static str

fn value_type() -> ValueType

impl<T: 'static> TypeName for &mut External<T>

fn type_name() -> &'static str

fn value_type() -> ValueType

impl<T: 'static> ValidateNapiValue for &External<T>

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

Safety

impl<T: 'static> ValidateNapiValue for &mut External<T>

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

Safety