Struct Function 

pub struct Function<'scope, Args: JsValuesTupleIntoVec = Unknown<'scope>, Return = Unknown<'scope>> { /* private fields */ }

A JavaScript function. It can only live in the scope of a function call. If you want to use it outside the scope of a function call, you can turn it into a reference. By calling the create_ref method.

Implementations

impl<Args: JsValuesTupleIntoVec, Return> Function<'_, Args, Return>

pub fn name(&self) -> Result<String>

Get the name of the JavaScript function.

pub fn create_ref(&self) -> Result<FunctionRef<Args, Return>>

Create a reference to the JavaScript function.

pub fn new_instance<'a>(&self, args: Args) -> Result<Unknown<'a>>

Create a new instance of the JavaScript Class.

pub fn build_threadsafe_function<T: 'static>( &self, ) -> ThreadsafeFunctionBuilder<'_, T, Args, Return>

Create a threadsafe function from the JavaScript function.

impl<Args: JsValuesTupleIntoVec, Return: FromNapiValue> Function<'_, Args, Return>

pub fn call(&self, args: Args) -> Result<Return>

Call the JavaScript function. this in the JavaScript function will be undefined. If you want to specify this, you can use the apply method.

pub fn apply<Context: ToNapiValue>( &self, this: Context, args: Args, ) -> Result<Return>

Call the JavaScript function. this in the JavaScript function will be the provided this.

pub fn bind<T: ToNapiValue>( &self, this: T, ) -> Result<Function<'_, Args, Return>>

Call Function.bind

Trait Implementations

impl<'scope, Args: Clone + JsValuesTupleIntoVec, Return: Clone> Clone for Function<'scope, Args, Return>

fn clone(&self) -> Function<'scope, Args, Return>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Args: JsValuesTupleIntoVec, Return> FromNapiValue for Function<'_, Args, Return>

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

This function called to convert napi values to native rust values

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

impl<'env, Args: JsValuesTupleIntoVec, Return> JsObjectValue<'env> for Function<'env, Args, Return>

fn set_property<'k, 'v, K, V>(&mut self, key: K, value: V) -> Result<()>

where K: JsValue<'k>, V: JsValue<'v>,

Set the property value to the Object

fn get_property<'k, K, T>(&self, key: K) -> Result<T>

where K: JsValue<'k>, T: FromNapiValue + ValidateNapiValue,

Get the property value from the Object

fn get_property_unchecked<'k, K, T>(&self, key: K) -> Result<T>

where K: JsValue<'k>, T: FromNapiValue,

Get the property value from the Object without validation

fn set_named_property<T>(&mut self, name: &str, value: T) -> Result<()>

where T: ToNapiValue,

Set the property value to the Object

fn set_c_named_property<T>(&mut self, name: &CStr, value: T) -> Result<()>

where T: ToNapiValue,

Set the property value to the Object, the property name is a CStr This is useful when the property name comes from a C library

fn create_named_method<K>(&mut self, name: K, function: Callback) -> Result<()>

where K: AsRef<str>,

Create a named method on the Object

fn create_c_named_method( &mut self, name: &CStr, function: Callback, ) -> Result<()>

Create a named method on the Object, the name is a CStr This is useful when the method name comes from a C library

fn get_named_property<T>(&self, name: &str) -> Result<T>

where T: FromNapiValue + ValidateNapiValue,

Get the property value from the Object

fn get_c_named_property<T>(&self, name: &CStr) -> Result<T>

where T: FromNapiValue + ValidateNapiValue,

Get the property value from the Object

fn get_named_property_unchecked<T>(&self, name: &str) -> Result<T>

where T: FromNapiValue,

Get the property value from the Object without validation

fn get_c_named_property_unchecked<T>(&self, name: &CStr) -> Result<T>

where T: FromNapiValue,

Get the property value from the Object without validation

fn has_named_property<N: AsRef<str>>(&self, name: N) -> Result<bool>

Check if the Object has the named property

fn has_c_named_property(&self, name: &CStr) -> Result<bool>

Check if the Object has the named property

fn delete_property<'s, S>(&mut self, name: S) -> Result<bool>

where S: JsValue<'s>,

Delete the property from the Object, the property name can be a JsValue

fn delete_named_property<K: AsRef<str>>(&mut self, name: K) -> Result<bool>

Delete the property from the Object

fn delete_c_named_property(&mut self, name: &CStr) -> Result<bool>

Delete the property from the Object

fn has_own_property(&self, key: &str) -> Result<bool>

Check if the Object has the own property

fn has_c_own_property(&self, key: &CStr) -> Result<bool>

Check if the Object has the own property

fn has_own_property_js<'k, K>(&self, key: K) -> Result<bool>

where K: JsValue<'k>,

The same as has_own_property, but accepts a JsValue as the property name.

fn has_property(&self, name: &str) -> Result<bool>

This API checks if the Object passed in has the named property.

fn has_property_js<'k, K>(&self, name: K) -> Result<bool>

where K: JsValue<'k>,

This API is the same as has_property, but accepts a JsValue as the property name. So you can pass the JsNumber or JsSymbol as the property name.

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

This API returns the names of the enumerable properties of object as an array of strings. The properties of object whose key is a symbol will not be included.

fn get_all_property_names( &self, mode: KeyCollectionMode, filter: KeyFilter, conversion: KeyConversion, ) -> Result<Object<'env>>

https://nodejs.org/api/n-api.html#n_api_napi_get_all_property_names This API returns an array containing the names of the available properties of this object.

fn get_prototype(&self) -> Result<Unknown<'env>>

This returns the equivalent of Object.getPrototypeOf (which is not the same as the function’s prototype property).

fn get_prototype_unchecked<T>(&self) -> Result<T>

where T: FromNapiValue,

Get the prototype of the Object

fn set_element<'t, T>(&mut self, index: u32, value: T) -> Result<()>

where T: JsValue<'t>,

Set the element at the given index

fn has_element(&self, index: u32) -> Result<bool>

Check if the Array has the element at the given index

fn delete_element(&mut self, index: u32) -> Result<bool>

Delete the element at the given index

fn get_element<T>(&self, index: u32) -> Result<T>

where T: FromNapiValue,

Get the element at the given index

fn define_properties(&mut self, properties: &[Property]) -> Result<()>

This method allows the efficient definition of multiple properties on a given object.

fn get_array_length(&self) -> Result<u32>

Perform is_array check before get the length

fn get_array_length_unchecked(&self) -> Result<u32>

use this API if you can ensure this Object is Array

fn wrap<T: 'static>( &mut self, native_object: T, size_hint: Option<usize>, ) -> Result<()>

Wrap the native value T to this Object the T will be dropped when this Object is finalized

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

Get the wrapped native value from the Object

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

Remove the wrapped native value from the Object

fn add_finalizer<T, Hint, F>( &mut self, native: T, finalize_hint: Hint, finalize_cb: F, ) -> Result<()>

where T: 'static, Hint: 'static, F: FnOnce(FinalizeContext<T, Hint>) + 'static,

Adds a finalize_cb callback which will be called when the JavaScript object in js_object has been garbage-collected.

fn freeze(&mut self) -> Result<()>

This method freezes a given object. This prevents new properties from being added to it, existing properties from being removed, prevents changing the enumerability, configurability, or writability of existing properties, and prevents the values of existing properties from being changed. It also prevents the object’s prototype from being changed. This is described in Section 19.1.2.6 of the ECMA-262 specification.

fn seal(&mut self) -> Result<()>

This method seals a given object. This prevents new properties from being added to it, as well as marking all existing properties as non-configurable. This is described in Section 19.1.2.20 of the ECMA-262 specification.

impl<'env, Args: JsValuesTupleIntoVec, Return> JsValue<'env> for Function<'env, Args, Return>

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<Args: JsValuesTupleIntoVec, Return> TypeName for Function<'_, Args, Return>

fn type_name() -> &'static str

fn value_type() -> ValueType

impl<Args: JsValuesTupleIntoVec, Return> ValidateNapiValue for Function<'_, Args, Return>

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

This function called to validate whether napi value passed to rust is valid type.

impl<'scope, Args: Copy + JsValuesTupleIntoVec, Return: Copy> Copy for Function<'scope, Args, Return>