Struct JsArray

pub struct JsArray(/* private fields */);

The type of JavaScript Array objects.

An array is any JavaScript value for which Array.isArray would return true.

Example

// Create a new empty array:
let a: Handle<JsArray> = cx.empty_array();

// Push some values onto the array:
a.prop(&mut cx, 0).set(17)?;
a.prop(&mut cx, 1).set("hello")?;

Implementations

impl JsArray

pub fn new<'a, C: Context<'a>>(cx: &mut C, len: usize) -> Handle<'a, JsArray>

Constructs a new empty array of length len, equivalent to the JavaScript expression new Array(len).

Note that for non-zero len, this creates a sparse array, which can sometimes have surprising behavior. To ensure that a new array is and remains dense (i.e., not sparse), consider creating an empty array with JsArray::new(cx, 0) or cx.empty_array() and only appending elements to the end of the array.

See also: Context::empty_array

pub fn to_vec<'a, C: Context<'a>>( &self, cx: &mut C, ) -> NeonResult<Vec<Handle<'a, JsValue>>>

Copies the array contents into a new Vec by iterating through all indices from 0 to self.len().

The length is dynamically checked on each iteration in case the array is modified during the computation.

pub fn len<'a, C: Context<'a>>(&self, cx: &mut C) -> u32

Returns the length of the array, equivalent to the JavaScript expression this.length.

pub fn is_empty<'a, C: Context<'a>>(&self, cx: &mut C) -> bool

Indicates whether the array is empty, equivalent to self.len() == 0.

Trait Implementations

impl Debug for JsArray

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

Formats the value using the given formatter.

impl Object for JsArray

fn prop<'a, 'cx: 'a, K: PropertyKey>( &self, cx: &'a mut Cx<'cx>, key: K, ) -> PropOptions<'a, 'cx, Self, K>

Create a PropOptions for accessing a property.

fn method<'a, 'cx: 'a, K: PropertyKey>( &self, cx: &'a mut Cx<'cx>, key: K, ) -> NeonResult<BindOptions<'a, 'cx>>

Gets a property from the object as a method and binds this to the object.

fn get_opt<'a, V: Value, C: Context<'a>, K: PropertyKey>( &self, cx: &mut C, key: K, ) -> NeonResult<Option<Handle<'a, V>>>

👎Deprecating in a future version: use Object::prop() instead

fn get_value<'a, C: Context<'a>, K: PropertyKey>( &self, cx: &mut C, key: K, ) -> NeonResult<Handle<'a, JsValue>>

👎Deprecating in a future version: use Object::prop() instead

fn get<'a, V: Value, C: Context<'a>, K: PropertyKey>( &self, cx: &mut C, key: K, ) -> NeonResult<Handle<'a, V>>

👎Deprecating in a future version: use Object::prop() instead

fn get_own_property_names<'a, C: Context<'a>>( &self, cx: &mut C, ) -> JsResult<'a, JsArray>

Available on crate feature napi-6 only.

fn freeze<'a, C: Context<'a>>(&self, cx: &mut C) -> NeonResult<&Self>

fn seal<'a, C: Context<'a>>(&self, cx: &mut C) -> NeonResult<&Self>

fn set<'a, C: Context<'a>, K: PropertyKey, W: Value>( &self, cx: &mut C, key: K, val: Handle<'_, W>, ) -> NeonResult<bool>

👎Deprecating in a future version: use Object::prop() instead

fn root<'a, C: Context<'a>>(&self, cx: &mut C) -> Root<Self>

fn call_method_with<'a, C, K>( &self, cx: &mut C, method: K, ) -> NeonResult<CallOptions<'a>>

where C: Context<'a>, K: PropertyKey,

👎Deprecating in a future version: use Object::method() instead

impl Value for JsArray

fn to_string<'cx, C: Context<'cx>>(&self, cx: &mut C) -> JsResult<'cx, JsString>

fn as_value<'cx, C: Context<'cx>>(&self, _: &mut C) -> Handle<'cx, JsValue>

fn to_raw(&self) -> Value

Available on crate feature sys only.

Get a raw reference to the wrapped Node-API value.

unsafe fn from_raw<'cx, C: Context<'cx>>( cx: &C, value: Value, ) -> Handle<'cx, Self>

Available on crate feature sys only.

Creates a value from a raw Node-API value.