Struct ndata::dataobject::DataObject

pub struct DataObject {
    pub data_ref: usize,
}

Represents a map of type <String, ndata.Data>.

Fields

data_ref: usize

The pointer to the object in the object heap.

Implementations

impl DataObject

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

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

pub fn share() -> ((u64, u64), (u64, u64))

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

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

pub fn new() -> DataObject

Create a new (empty) object.

pub fn get(data_ref: usize) -> DataObject

Get a reference to the object from the heap

pub fn incr(&self)

Increase the reference count for this DataObject.

pub fn decr(&self)

Decrease the reference count for this DataObject.

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

Create a new DataObject from a JSON string.

pub fn to_string(&self) -> String

Create a JSON string from a DataObject.

pub fn duplicate(&self) -> DataObject

👎Deprecated since 0.3.0: please use clone instead

Returns a new DataObject that points to the same underlying object instance.

pub fn shallow_copy(&self) -> DataObject

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

pub fn deep_copy(&self) -> DataObject

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

pub fn has(&self, key: &str) -> bool

Returns true if this object contains the given key.

pub fn keys(self) -> Vec<String>

Returns a list (Vec<String>) of the keys in this object.

pub fn get_property(&self, key: &str) -> Data

Returns the stored value for the given key.

pub fn get_string(&self, key: &str) -> String

Returns the stored value for the given key as a String.

pub fn get_bool(&self, key: &str) -> bool

👎Deprecated since 0.3.0: please use get_boolean instead

Returns the stored value for the given key as a bool.

pub fn get_i64(&self, key: &str) -> i64

👎Deprecated since 0.3.0: please use get_int instead

Returns the stored value for the given key as an i64.

pub fn get_f64(&self, key: &str) -> f64

👎Deprecated since 0.3.0: please use get_float instead

Returns the stored value for the given key as an f64.

pub fn get_boolean(&self, key: &str) -> bool

Returns the stored value for the given key as a bool.

pub fn get_int(&self, key: &str) -> i64

Returns the stored value for the given key as an i64.

pub fn get_float(&self, key: &str) -> f64

Returns the stored value for the given key as an f64.

pub fn get_object(&self, key: &str) -> DataObject

Returns the stored value for the given key as a DataObject.

pub fn get_array(&self, key: &str) -> DataArray

Returns the stored value for the given key as a DataArray.

pub fn get_bytes(&self, key: &str) -> DataBytes

Returns the stored value for the given key as a DataBytes.

pub fn remove_property(&mut self, key: &str)

Remove the value from the object for the given key.

pub fn set_property(&mut self, key: &str, data: Data)

Set the given value for the given key.

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

👎Deprecated since 0.3.0: please use put_string instead

Set the given String value for the given key.

pub fn put_bool(&mut self, key: &str, val: bool)

👎Deprecated since 0.3.0: please use put_booolean instead

Set the given bool value for the given key.

pub fn put_i64(&mut self, key: &str, val: i64)

👎Deprecated since 0.3.0: please use put_int instead

Set the given i64 value for the given key.

pub fn put_string(&mut self, key: &str, val: &str)

Set the given String value for the given key.

pub fn put_boolean(&mut self, key: &str, val: bool)

Set the given bool value for the given key.

pub fn put_int(&mut self, key: &str, val: i64)

Set the given i64 value for the given key.

pub fn put_float(&mut self, key: &str, val: f64)

Set the given f64 value for the given key.

pub fn put_object(&mut self, key: &str, o: DataObject)

Set the given DataObject value for the given key.

pub fn put_list(&mut self, key: &str, a: DataArray)

👎Deprecated since 0.1.2: please use put_array instead

pub fn put_array(&mut self, key: &str, a: DataArray)

Set the given DataArray value for the given key.

pub fn put_bytes(&mut self, key: &str, a: DataBytes)

Set the given DataBytes value for the given key.

pub fn put_null(&mut self, key: &str)

Set the for the given key to DNull.

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

DO NOT USE

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

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

Returns the key value pairs in this object as a Vec<String, Data>.

pub fn print_heap()

Prints the objects currently stored in the heap

pub fn gc()

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

Trait Implementations

impl Clone for DataObject

fn clone(&self) -> Self

Returns another DataObject pointing to the same value.

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

Performs copy-assignment from source.

impl Debug for DataObject

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

Formats the value using the given formatter.

impl Default for DataObject

fn default() -> DataObject

Returns the “default value” for a type.

impl Drop for DataObject

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

fn drop(&mut self)

Executes the destructor for this type.