Struct nodex_api::descriptor::DescriptorMethodBuilder

pub struct DescriptorMethodBuilder<T: NapiValueT, R: NapiValueT, const N: usize> {
    pub utf8name: Option<String>,
    pub name: napi_value,
    pub method: Option<Box<dyn FnMut(JsObject, [T; N]) -> NapiResult<R> + 'static>>,
    pub attributes: NapiPropertyAttributes,
}

The DescriptorBuild for method. NB: there seems no way to reclaim the napi_property_descriptor.data, so it is leaked.

Fields

utf8name: Option<String>

name: napi_value

method: Option<Box<dyn FnMut(JsObject, [T; N]) -> NapiResult<R> + 'static>>

attributes: NapiPropertyAttributes

Implementations

impl<T: NapiValueT, R: NapiValueT, const N: usize> DescriptorMethodBuilder<T, R, N>

pub fn new() -> Self

pub fn with_utf8name(self, name: impl Into<String>) -> Self

Optional string describing the key for the property, encoded as UTF8. One of utf8name or name must be provided for the property.

pub fn with_name(self, name: impl NapiValueT) -> Self

Optional napi_value that points to a JavaScript string or symbol to be used as the key for the property. One of utf8name or name must be provided for the property.

pub fn with_method(
    self,
    method: impl FnMut(JsObject, [T; N]) -> NapiResult<R> + 'static
) -> Self

Set this to make the property descriptor object’s value property to be a JavaScript function represented by method. If this is passed in, set value, getter and setter to NULL (since these members won’t be used). napi_callback provides more details.

pub fn with_attribute(self, attribute: NapiPropertyAttributes) -> Self

The attributes associated with the particular property. See napi_property_attributes.

pub fn build(self) -> NapiResult<NapiPropertyDescriptor>

build finale NapiPropertyDescriptor

Trait Implementations

impl<T: NapiValueT, R: NapiValueT, const N: usize> Default for DescriptorMethodBuilder<T, R, N>

fn default() -> Self

Returns the “default value” for a type.