Struct nodex_api::value::JsBuffer

pub struct JsBuffer<const N: usize>(_);

Implementations

impl<const N: usize> JsBuffer<N>

pub fn create(env: NapiEnv) -> NapiResult<JsBuffer<N>>

This API allocates a node::Buffer object. While this is still a fully-supported data structure, in most cases using a TypedArray will suffice.

pub fn create_copy(env: NapiEnv, data: [u8; N]) -> NapiResult<JsBuffer<N>>

This API allocates a node::Buffer object and initializes it with data copied from the passed-in buffer. While this is still a fully-supported data structure, in most cases using a TypedArray will suffice.

pub fn get(&self) -> NapiResult<&[u8]>

Get the underlaying array

pub fn get_mut(&mut self) -> NapiResult<&mut [u8]>

Get the underlaying array (mut)

pub const fn len(&self) -> usize

The length of current buffer.

pub const fn is_empty(&self) -> bool

The buffer is empty

Trait Implementations

impl<const N: usize> Clone for JsBuffer<N>

fn clone(&self) -> JsBuffer<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for JsBuffer<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const N: usize> Index<usize> for JsBuffer<N>

type Output = u8

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const N: usize> NapiValueT for JsBuffer<N>

fn from_raw(env: NapiEnv, raw: napi_value) -> JsBuffer<N>

construct value from raw pointer

fn value(&self) -> JsValue

inner value

fn cast<T: NapiValueT>(&self) -> T

napi_value type cast

fn coerce_to_bool(&self) -> NapiResult<JsBoolean>

This API implements the abstract operation ToBoolean() as defined in Section 7.1.2 of the ECMAScript Language Specification.

fn coerce_coerce_to_number(&self) -> NapiResult<JsNumber>

This API implements the abstract operation ToNumber() as defined in Section 7.1.3 of the ECMAScript Language Specification. This function potentially runs JS code if the passed-in value is an object.

fn coerce_to_object(&self) -> NapiResult<JsObject>

This API implements the abstract operation ToObject() as defined in Section 7.1.13 of the ECMAScript Language Specification.

fn coerce_to_string(&self) -> NapiResult<JsString>

This API implements the abstract operation ToString() as defined in Section 7.1.13 of the ECMAScript Language Specification. This function potentially runs JS code if the passed-in value is an object.

fn instance_of(&self, constructor: JsFunction) -> NapiResult<bool>

This API represents invoking the instanceof Operator on the object as defined in Section 12.10.4 of the ECMAScript Language Specification.

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

This API represents invoking the IsArray operation on the object as defined in Section 7.2.2 of the ECMAScript Language Specification.

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

This API checks if the Object passed in is an array buffer.

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

This API checks if the Object passed in is a buffer.

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

This API checks if the Object passed in is a error.

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

This API checks if the Object passed in is a typed array.

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

This API checks if the Object passed in is a DataView.

fn equals(&self, rhs: impl NapiValueT) -> NapiResult<bool>

This API represents the invocation of the Strict Equality algorithm as defined in Section 7.2.14 of the ECMAScript Language Specification.

fn kind(&self) -> NapiResult<NapiValuetype>

Returns napi_ok if the API succeeded.

fn env(&self) -> NapiEnv

the NapiEnv of current value

fn raw(&self) -> napi_value

the raw-handle of current value

fn null(&self) -> NapiResult<JsNull>

get null singleton

fn undefined(&self) -> NapiResult<JsUndefined>

get undefined singleton

fn global(&self) -> NapiResult<JsGlobal>

get global singleton

fn throw(&self) -> NapiResult<()>

value is throwable

fn define_properties<P>(&self, properties: P) -> NapiResult<()> where
    P: AsRef<[NapiPropertyDescriptor]>, 

This method allows the efficient definition of multiple properties on a given object. The properties are defined using property descriptors (see napi_property_descriptor). Given an array of such property descriptors, this API will set the properties on the object one at a time, as defined by DefineOwnProperty() (described in Section 9.1.6 of the ECMA-262 specification).

fn gc<Finalizer>(&mut self, finalizer: Finalizer) -> NapiResult<NapiRef> where
    Finalizer: FnOnce(NapiEnv) -> NapiResult<()>, 

This is a hook which is fired when the value is gabage-collected. For napi >= 5, we use napi_add_finalizer, For napi < 5, we use napi_wrap.

fn wrap<T, Finalizer>(
    &mut self,
    data: T,
    finalizer: Finalizer
) -> NapiResult<NapiRef> where
    Finalizer: FnOnce(NapiEnv, T) -> NapiResult<()>, 

Wraps a native instance in a JavaScript object. The native instance can be retrieved later using napi_unwrap().

fn unwrap<T>(&self) -> NapiResult<Option<&T>>

Retrieves a native instance that was previously wrapped in a JavaScript object using napi_wrap().

fn remove_wrap<T>(&mut self) -> NapiResult<T>

Retrieves a native instance that was previously wrapped in the JavaScript object js_object using napi_wrap() and removes the wrapping. If a finalize callback was associated with the wrapping, it will no longer be called when the JavaScript object becomes garbage-collected.

impl<const N: usize> Copy for JsBuffer<N>