Struct DescriptorMethodBuilder

Source
pub struct DescriptorMethodBuilder<T: FromJsArgs, R: NapiValueT> {
    pub utf8name: Option<String>,
    pub name: napi_value,
    pub method: Option<Box<dyn FnMut(JsObject, T) -> NapiResult<R> + 'static>>,
    pub attributes: NapiPropertyAttributes,
}
Expand description

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) -> NapiResult<R> + 'static>>§attributes: NapiPropertyAttributes

Implementations§

Source§

impl<T: FromJsArgs, R: NapiValueT> DescriptorMethodBuilder<T, R>

Source

pub fn new() -> Self

Source

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.

Source

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.

Source

pub fn with_method( self, method: impl FnMut(JsObject, T) -> 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.

Source

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

The attributes associated with the particular property. See napi_property_attributes.

Source

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

build finale NapiPropertyDescriptor

Trait Implementations§

Source§

impl<T: FromJsArgs, R: NapiValueT> Default for DescriptorMethodBuilder<T, R>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T, R> Freeze for DescriptorMethodBuilder<T, R>

§

impl<T, R> !RefUnwindSafe for DescriptorMethodBuilder<T, R>

§

impl<T, R> !Send for DescriptorMethodBuilder<T, R>

§

impl<T, R> !Sync for DescriptorMethodBuilder<T, R>

§

impl<T, R> Unpin for DescriptorMethodBuilder<T, R>

§

impl<T, R> !UnwindSafe for DescriptorMethodBuilder<T, R>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.