Struct ndata::dataarray::DataArray

pub struct DataArray {
    pub data_ref: usize,
}

Represents an array of type ndata.Data.

Fields

data_ref: usize

The pointer to the array in the array heap.

Implementations

impl DataArray

pub fn init() -> ((usize, usize), (usize, usize))

Initialize global storage of arrays. Call only once at startup.

pub fn mirror(q: (usize, usize), r: (usize, usize))

Mirror global storage of arrays from another process. Call only once at startup.

pub fn new() -> DataArray

Create a new (empty) array.

pub fn get(data_ref: usize) -> DataArray

Get a reference to the array from the heap

pub fn incr(&self)

Increase the reference count for this DataArray.

pub fn decr(&self)

Decrease the reference count for this DataArray.

pub fn from_string(s: &str) -> DataArray

Create a new DataArray from a JSON string.

pub fn to_string(&self) -> String

Create a JSON string from a DataArray.

pub fn duplicate(&self) -> DataArray

Returns a new DataArray that points to the same underlying array instance.

pub fn shallow_copy(self) -> DataArray

Returns a new DataArray that points to a new array instance, which contains the same underlying data as the original.

pub fn deep_copy(&self) -> DataArray

Returns a new DataArray that points to a new array instance, which contains a recursively deep copy of the original underlying data.

pub fn len(&self) -> usize

Returns the length of the array.

pub fn index_of(&self, b: Data) -> i64

Returns the index of a Data in the array

pub fn push_unique(&self, b: Data) -> bool

Push data if not already in array

pub fn remove_data(&self, b: Data) -> bool

Returns the index of a Data in the array

pub fn get_property(&self, id: usize) -> Data

Returns the indexed value from the array

pub fn get_string(&self, id: usize) -> String

Returns the indexed value from the array as a String

pub fn get_bool(&self, id: usize) -> bool

Returns the indexed value from the array as a bool

pub fn get_i64(&self, id: usize) -> i64

Returns the indexed value from the array as an i64

pub fn get_f64(&self, id: usize) -> f64

Returns the indexed value from the array as an f64

pub fn get_array(&self, id: usize) -> DataArray

Returns the indexed value from the array as a DataArray

pub fn get_object(&self, id: usize) -> DataObject

Returns the indexed value from the array as a DataObject

pub fn get_bytes(&self, id: usize) -> DataBytes

Returns the indexed value from the array as a DataBytes

pub fn join(&mut self, a: DataArray)

Append all values from another array

pub fn push_property(&mut self, data: Data)

Append the given value to the end of the array

pub fn push_str(&mut self, val: &str)

Append the given String to the end of the array

pub fn push_bool(&mut self, val: bool)

Append the given bool to the end of the array

pub fn push_i64(&mut self, val: i64)

Append the given i64 to the end of the array

pub fn push_float(&mut self, val: f64)

Append the given f64 to the end of the array

pub fn push_object(&mut self, o: DataObject)

Append the given DataObject to the end of the array

pub fn push_list(&mut self, a: DataArray)

👎Deprecated since 0.1.2: please use push_array instead

pub fn push_array(&mut self, a: DataArray)

Append the given DataArray to the end of the array

pub fn push_bytes(&mut self, a: DataBytes)

Append the given DataBytes to the end of the array

pub fn set_property(&mut self, id: usize, data: Data)

Replace the indexed value in the array

pub fn put_str(&mut self, id: usize, val: &str)

Replace the indexed value in the array with the given String.

pub fn put_bool(&mut self, id: usize, val: bool)

Replace the indexed value in the array with the given bool.

pub fn put_i64(&mut self, id: usize, val: i64)

Replace the indexed value in the array with the given i64.

pub fn put_float(&mut self, id: usize, val: f64)

Replace the indexed value in the array with the given f64.

pub fn put_object(&mut self, id: usize, o: DataObject)

Replace the indexed value in the array with the given DataObject.

pub fn put_array(&mut self, id: usize, a: DataArray)

Replace the indexed value in the array with the given DataArray.

pub fn put_bytes(&mut self, id: usize, a: DataBytes)

Replace the indexed value in the array with the given DataBytes.

pub fn remove_property(&mut self, id: usize)

Remove the indexed value from the array

pub fn delete(
    aheap: &mut Heap<Vec<Data>>,
    data_ref: usize,
    oheap: &mut Heap<HashMap<String, Data>>
)

DO NOT USE

Reduces the reference count for this array by one, as well as the reference counts of any objects, arrays, or byte buffers contained in this array. This function should only be used externally by DataObject::gc().

pub fn objects(&self) -> Vec<Data>

Returns this array as a Vec<Data>.

pub fn print_heap()

Prints the arrays currently stored in the heap

pub fn gc()

Perform garbage collection. Arrays will not be removed from the heap until DataArray::gc() is called.

Trait Implementations

impl Debug for DataArray

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

Formats the value using the given formatter.

impl Default for DataArray

fn default() -> DataArray

Returns the “default value” for a type.

impl Drop for DataArray

Adds this DataArray’s data_ref to ODROP. Reference counts are adjusted when DataArray::gc() is called.

fn drop(&mut self)

Executes the destructor for this type.