[][src]Struct js_sys::Array

#[repr(transparent)]
pub struct Array { /* fields omitted */ }

Methods

impl Array[src]

pub fn new() -> Array[src]

Creates a new empty array.

impl Array[src]

pub fn new_with_length(len: u32) -> Array[src]

Creates a new array with the specified length (elements are initialized to undefined).

impl Array[src]

pub fn get(&self, index: u32) -> JsValue[src]

Retrieves the element at the index (returns undefined if the index is out of range).

impl Array[src]

pub fn set(&self, index: u32, value: JsValue)[src]

Sets the element at the index (auto-enlarges the array if the index is out of range).

impl Array[src]

pub fn delete(&self, index: u32)[src]

Deletes the element at the index (does nothing if the index is out of range).

The element at the index is set to undefined.

This does not resize the array, the array will still be the same length.

impl Array[src]

pub fn from(val: &JsValue) -> Array[src]

The Array.from() method creates a new, shallow-copied Array instance from an array-like or iterable object.

impl Array[src]

pub fn copy_within(&self, target: i32, start: i32, end: i32) -> Array[src]

The copyWithin() method shallow copies part of an array to another location in the same array and returns it, without modifying its size.

MDN documentation

impl Array[src]

pub fn concat(&self, array: &Array) -> Array[src]

The concat() method is used to merge two or more arrays. This method does not change the existing arrays, but instead returns a new array.

MDN documentation

impl Array[src]

pub fn every(
    &self,
    predicate: &mut dyn FnMut(JsValue, u32, Array) -> bool
) -> bool
[src]

The every() method tests whether all elements in the array pass the test implemented by the provided function.

MDN documentation

impl Array[src]

pub fn fill(&self, value: &JsValue, start: u32, end: u32) -> Array[src]

The fill() method fills all the elements of an array from a start index to an end index with a static value. The end index is not included.

MDN documentation

impl Array[src]

pub fn filter(
    &self,
    predicate: &mut dyn FnMut(JsValue, u32, Array) -> bool
) -> Array
[src]

The filter() method creates a new array with all elements that pass the test implemented by the provided function.

MDN documentation

impl Array[src]

pub fn find(
    &self,
    predicate: &mut dyn FnMut(JsValue, u32, Array) -> bool
) -> JsValue
[src]

The find() method returns the value of the first element in the array that satisfies the provided testing function. Otherwise undefined is returned.

MDN documentation

impl Array[src]

pub fn find_index(
    &self,
    predicate: &mut dyn FnMut(JsValue, u32, Array) -> bool
) -> i32
[src]

The findIndex() method returns the index of the first element in the array that satisfies the provided testing function. Otherwise -1 is returned.

MDN documentation

impl Array[src]

pub fn flat(&self, depth: i32) -> Array[src]

The flat() method creates a new array with all sub-array elements concatenated into it recursively up to the specified depth.

MDN documentation

impl Array[src]

pub fn flat_map(
    &self,
    callback: &mut dyn FnMut(JsValue, u32, Array) -> Vec<JsValue>
) -> Array
[src]

The flatMap() method first maps each element using a mapping function, then flattens the result into a new array.

MDN documentation

impl Array[src]

pub fn for_each(&self, callback: &mut dyn FnMut(JsValue, u32, Array))[src]

The forEach() method executes a provided function once for each array element.

MDN documentation

impl Array[src]

pub fn includes(&self, value: &JsValue, from_index: i32) -> bool[src]

The includes() method determines whether an array includes a certain element, returning true or false as appropriate.

MDN documentation

impl Array[src]

pub fn index_of(&self, value: &JsValue, from_index: i32) -> i32[src]

The indexOf() method returns the first index at which a given element can be found in the array, or -1 if it is not present.

MDN documentation

impl Array[src]

pub fn is_array(value: &JsValue) -> bool[src]

The Array.isArray() method determines whether the passed value is an Array.

MDN documentation

impl Array[src]

pub fn join(&self, delimiter: &str) -> JsString[src]

The join() method joins all elements of an array (or an array-like object) into a string and returns this string.

MDN documentation

impl Array[src]

pub fn last_index_of(&self, value: &JsValue, from_index: i32) -> i32[src]

The lastIndexOf() method returns the last index at which a given element can be found in the array, or -1 if it is not present. The array is searched backwards, starting at fromIndex.

MDN documentation

impl Array[src]

pub fn length(&self) -> u32[src]

The length property of an object which is an instance of type Array sets or returns the number of elements in that array. The value is an unsigned, 32-bit integer that is always numerically greater than the highest index in the array.

MDN documentation

impl Array[src]

pub fn map(
    &self,
    predicate: &mut dyn FnMut(JsValue, u32, Array) -> JsValue
) -> Array
[src]

map() calls a provided callback function once for each element in an array, in order, and constructs a new array from the results. callback is invoked only for indexes of the array which have assigned values, including undefined. It is not called for missing elements of the array (that is, indexes that have never been set, which have been deleted or which have never been assigned a value).

MDN documentation

impl Array[src]

pub fn of1(a: &JsValue) -> Array[src]

The Array.of() method creates a new Array instance with a variable number of arguments, regardless of number or type of the arguments.

The difference between Array.of() and the Array constructor is in the handling of integer arguments: Array.of(7) creates an array with a single element, 7, whereas Array(7) creates an empty array with a length property of 7 (Note: this implies an array of 7 empty slots, not slots with actual undefined values).

MDN documentation

Notes

There are a few bindings to of in js-sys: of1, of2, etc... with different arities.

impl Array[src]

pub fn of2(a: &JsValue, b: &JsValue) -> Array[src]

impl Array[src]

pub fn of3(a: &JsValue, b: &JsValue, c: &JsValue) -> Array[src]

impl Array[src]

pub fn of4(a: &JsValue, b: &JsValue, c: &JsValue, d: &JsValue) -> Array[src]

impl Array[src]

pub fn of5(
    a: &JsValue,
    b: &JsValue,
    c: &JsValue,
    d: &JsValue,
    e: &JsValue
) -> Array
[src]

impl Array[src]

pub fn pop(&self) -> JsValue[src]

The pop() method removes the last element from an array and returns that element. This method changes the length of the array.

MDN documentation

impl Array[src]

pub fn push(&self, value: &JsValue) -> u32[src]

The push() method adds one or more elements to the end of an array and returns the new length of the array.

MDN documentation

impl Array[src]

pub fn reduce(
    &self,
    predicate: &mut dyn FnMut(JsValue, JsValue, u32, Array) -> JsValue,
    initial_value: &JsValue
) -> JsValue
[src]

The reduce() method applies a function against an accumulator and each element in the array (from left to right) to reduce it to a single value.

MDN documentation

impl Array[src]

pub fn reduce_right(
    &self,
    predicate: &mut dyn FnMut(JsValue, JsValue, u32, Array) -> JsValue,
    initial_value: &JsValue
) -> JsValue
[src]

The reduceRight() method applies a function against an accumulator and each value of the array (from right-to-left) to reduce it to a single value.

MDN documentation

impl Array[src]

pub fn reverse(&self) -> Array[src]

The reverse() method reverses an array in place. The first array element becomes the last, and the last array element becomes the first.

MDN documentation

impl Array[src]

pub fn shift(&self) -> JsValue[src]

The shift() method removes the first element from an array and returns that removed element. This method changes the length of the array.

MDN documentation

impl Array[src]

pub fn slice(&self, start: u32, end: u32) -> Array[src]

The slice() method returns a shallow copy of a portion of an array into a new array object selected from begin to end (end not included). The original array will not be modified.

MDN documentation

impl Array[src]

pub fn some(&self, predicate: &mut dyn FnMut(JsValue) -> bool) -> bool[src]

The some() method tests whether at least one element in the array passes the test implemented by the provided function. Note: This method returns false for any condition put on an empty array. MDN documentation

impl Array[src]

pub fn sort(&self) -> Array[src]

The sort() method sorts the elements of an array in place and returns the array. The sort is not necessarily stable. The default sort order is according to string Unicode code points.

The time and space complexity of the sort cannot be guaranteed as it is implementation dependent.

MDN documentation

impl Array[src]

pub fn splice(&self, start: u32, delete_count: u32, item: &JsValue) -> Array[src]

The splice() method changes the contents of an array by removing existing elements and/or adding new elements.

MDN documentation

impl Array[src]

pub fn to_locale_string(&self, locales: &JsValue, options: &JsValue) -> JsString[src]

The toLocaleString() method returns a string representing the elements of the array. The elements are converted to Strings using their toLocaleString methods and these Strings are separated by a locale-specific String (such as a comma “,”).

MDN documentation

impl Array[src]

pub fn to_string(&self) -> JsString[src]

The toString() method returns a string representing the specified array and its elements.

MDN documentation

impl Array[src]

pub fn unshift(&self, value: &JsValue) -> u32[src]

The unshift() method adds one or more elements to the beginning of an array and returns the new length of the array.

MDN documentation

impl Array[src]

Important traits for ArrayIter<'a>
pub fn iter(&self) -> ArrayIter[src]

Returns an iterator over the values of the JS array.

pub fn to_vec(&self) -> Vec<JsValue>[src]

Converts the JS array into a new Vec.

impl Array[src]

pub fn keys(&self) -> Iterator[src]

The keys() method returns a new Array Iterator object that contains the keys for each index in the array.

MDN documentation

impl Array[src]

pub fn entries(&self) -> Iterator[src]

The entries() method returns a new Array Iterator object that contains the key/value pairs for each index in the array.

MDN documentation

impl Array[src]

pub fn values(&self) -> Iterator[src]

The values() method returns a new Array Iterator object that contains the values for each index in the array.

MDN documentation

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function[src]

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool[src]

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool[src]

The isPrototypeOf() method checks if an object exists in another object's prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool[src]

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString[src]

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString[src]

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object[src]

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Trait Implementations

impl AsRef<Array> for Array[src]

impl AsRef<JsValue> for Array[src]

impl AsRef<Object> for Array[src]

impl Clone for Array[src]

impl Debug for Array[src]

impl Deref for Array[src]

type Target = Object

The resulting type after dereferencing.

impl Eq for Array[src]

impl From<Array> for JsValue[src]

impl From<Array> for Object[src]

impl From<JsValue> for Array[src]

impl<A> FromIterator<A> for Array where
    A: AsRef<JsValue>, 
[src]

impl FromWasmAbi for Array[src]

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

impl IntoWasmAbi for Array[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl<'a> IntoWasmAbi for &'a Array[src]

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl JsCast for Array[src]

impl OptionFromWasmAbi for Array[src]

impl OptionIntoWasmAbi for Array[src]

impl<'a> OptionIntoWasmAbi for &'a Array[src]

impl PartialEq<Array> for Array[src]

impl RefFromWasmAbi for Array[src]

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Array>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous. Read more

impl StructuralEq for Array[src]

impl StructuralPartialEq for Array[src]

impl WasmDescribe for Array[src]

Auto Trait Implementations

impl RefUnwindSafe for Array

impl !Send for Array

impl !Sync for Array

impl Unpin for Array

impl UnwindSafe for Array

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.