Struct Array 

pub struct Array<'a> {
    arr: Object<'a>,
}

Represents an Array in the JavaScript Runtime. Refer to MDN for more details.

Fields

arr: Object<'a>

Implementations

impl<'a> Array<'a>

pub fn new(cx: &'a Context) -> Array<'a>

Creates an empty Array.

pub fn new_with_length(cx: &'a Context, length: usize) -> Array<'a>

Creates an empty Array with the given length.

pub fn from_rooted_vec(cx: &'a Context, vec: &RootedVec<'_, JSVal>) -> Array<'a>

Creates an Array from a slice of values.

pub fn from_handle(cx: &'a Context, handle: HandleValueArray) -> Array<'a>

Creates an Array from a HandleValueArray.

pub fn from(cx: &Context, object: Local<'a, *mut JSObject>) -> Option<Array<'a>>

Creates an Array from an object.

Returns None if the object is not an array.

pub unsafe fn from_unchecked(object: Local<'a, *mut JSObject>) -> Array<'a>

Creates an Array from an object.

Safety

Object must be an array.

pub fn to_vec<'cx>(&self, cx: &'cx Context) -> Vec<Value<'cx>>

Converts an Array to a Vec. Returns an empty Vec if the conversion fails.

pub fn to_object(&self, cx: &'a Context) -> Object<'a>

Converts an Array to an Object.

pub fn len(&self, cx: &Context) -> u32

Returns the length of the Array.

pub fn is_empty(&self, cx: &Context) -> bool

Returns if the Array is empty.

pub fn has(&self, cx: &Context, index: u32) -> bool

Checks if the Array has a value at the given index.

pub fn get<'cx>( &self, cx: &'cx Context, index: u32, ) -> Result<Option<Value<'cx>>>

Gets the Value at the given index of the Array. Returns None if there is no value at the given index.

pub fn get_as<'cx, T: FromValue<'cx>>( &self, cx: &'cx Context, index: u32, strict: bool, config: T::Config, ) -> Result<Option<T>>

Gets the value at the given index of the Array as a Rust type. Returns None if there is no value at the given index or conversion to the Rust type fails.

pub fn get_descriptor<'cx>( &self, cx: &'cx Context, index: u32, ) -> Result<Option<PropertyDescriptor<'cx>>>

Gets the descriptor at the given index of the Array. Returns None if there is no value at the given index.

pub fn set(&self, cx: &Context, index: u32, value: &Value<'_>) -> bool

Sets the Value at the given index of the Array. Returns false if the element cannot be set.

pub fn set_as<'cx, T: ToValue<'cx> + ?Sized>( &self, cx: &'cx Context, index: u32, value: &T, ) -> bool

Sets the Rust type at the given index of the Array. Returns false if the element cannot be set.

pub fn define( &self, cx: &Context, index: u32, value: &Value<'_>, attrs: PropertyFlags, ) -> bool

Defines the Value at the given index of the Array with the given attributes. Returns false if the element cannot be defined.

pub fn define_as<'cx, T: ToValue<'cx> + ?Sized>( &self, cx: &'cx Context, index: u32, value: &T, attrs: PropertyFlags, ) -> bool

Defines the Rust type at the given index of the Array with the given attributes. Returns false if the element cannot be defined.

pub fn delete(&self, cx: &Context, index: u32) -> bool

Deletes the JSVal at the given index. Returns false if the element cannot be deleted.

pub fn indices<'cx>( &self, cx: &'cx Context, flags: Option<IteratorFlags>, ) -> ArrayIndicesIter<'cx>

pub fn iter<'cx, 's>( &'s self, cx: &'cx Context, flags: Option<IteratorFlags>, ) -> ArrayIter<'cx, 's>

where 'a: 'cx,

pub fn is_array_raw(cx: &Context, object: *mut JSObject) -> bool

Checks if a [*mut JSObject] is an array.

pub fn is_array(cx: &Context, object: &Local<'_, *mut JSObject>) -> bool

Checks if a [*mut JSObject] is an array.

pub fn as_object(&self) -> &Object<'a>

pub fn into_local(self) -> Local<'a, *mut JSObject>

Methods from Deref<Target = Local<'a, *mut JSObject>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'a> Debug for Array<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Array<'a>

type Target = Local<'a, *mut JSObject>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Array<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'cx> FromValue<'cx> for Array<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, _: bool, _: (), ) -> Result<Array<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToValue<'cx> for Array<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes