Struct Array 

pub struct Array { /* private fields */ }

An array data structure that supports various operations.

Implementations

impl Array

pub fn get_count(&self) -> i64

Gets the number of items in the array.

pub fn is_empty(&self) -> bool

Gets whether the array is empty or not.

pub fn add_range(&mut self, other: &Array)

Adds all items from another array to the end of this array.

Arguments

• other - Another array object.

pub fn remove_from(&mut self, other: &Array)

Removes all items from this array that are also in another array.

Arguments

• other - Another array object.

pub fn clear(&mut self)

Removes all items from the array.

pub fn reverse(&mut self)

Reverses the order of the items in the array.

pub fn shrink(&mut self)

Removes any empty slots from the end of the array. This method is used to release the unused memory this array holds.

pub fn swap(&mut self, index_a: i32, index_b: i32)

Swaps the items at two given indices.

Arguments

• index_a - The first index.
• index_b - The second index.

pub fn remove_at(&mut self, index: i32) -> bool

Removes the item at the given index.

Arguments

• index - The index to remove.

Returns

• bool - true if an item was removed, false otherwise.

pub fn fast_remove_at(&mut self, index: i32) -> bool

Removes the item at the given index without preserving the order of the array.

Arguments

• index - The index to remove.

Returns

• bool - true if an item was removed, false otherwise.

pub fn new() -> Array

Creates a new array object

impl Array

pub fn set<'a, T>(&mut self, index: i32, v: T)

where T: IntoValue<'a>,

Sets the item at the given index.

Arguments

• index - The index to set, should be 0 based.
• item - The new item value.

pub fn get(&self, index: i32) -> Option<Value>

Gets the item at the given index.

Arguments

• index - The index to get, should be 0 based.

Returns

• Option<Value> - The item value.

pub fn first(&self) -> Option<Value>

The first item in the array.

pub fn last(&self) -> Option<Value>

The last item in the array.

pub fn random_object(&self) -> Option<Value>

A random item from the array.

pub fn add<'a, T>(&mut self, v: T) -> &mut Self

where T: IntoValue<'a>,

Adds an item to the end of the array.

Arguments

• item - The item to add.

pub fn insert<'a, T>(&mut self, index: i32, v: T)

where T: IntoValue<'a>,

Inserts an item at the given index, shifting other items to the right.

Arguments

• index - The index to insert at.
• item - The item to insert.

pub fn contains<'a, T>(&self, v: T) -> bool

where T: IntoValue<'a>,

Checks whether the array contains a given item.

Arguments

• item - The item to check.

Returns

• bool - True if the item is found, false otherwise.

pub fn index<'a, T>(&self, v: T) -> i32

where T: IntoValue<'a>,

Gets the index of a given item.

Arguments

• item - The item to search for.

Returns

• i32 - The index of the item, or -1 if it is not found.

pub fn remove_last(&mut self) -> Option<Value>

Removes and returns the last item in the array.

Returns

• Option<Value> - The last item removed from the array.

pub fn fast_remove<'a, T>(&mut self, v: T) -> bool

where T: IntoValue<'a>,

Removes the first occurrence of a given item from the array without preserving order.

Arguments

• item - The item to remove.

Returns

• bool - True if the item was found and removed, false otherwise.

Trait Implementations

impl Clone for Array

fn clone(&self) -> Array

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for Array

fn drop(&mut self)

Executes the destructor for this type.

impl IObject for Array

fn raw(&self) -> i64

fn obj(&self) -> &dyn IObject

fn as_any(&self) -> &dyn Any

fn get_id(&self) -> i32