Module sui::object_table
Similar to sui::table, an ObjectTable<K, V> is a map-like collection. But unlike
sui::table, the values bound to these dynamic fields must be objects themselves. This allows
for the objects to still exist within in storage, which may be important for external tools.
The difference is otherwise not observable from within Move.
use std::ascii;
use std::bcs;
use std::option;
use std::string;
use std::vector;
use sui::address;
use sui::dynamic_field;
use sui::dynamic_object_field;
use sui::hex;
use sui::object;
use sui::tx_context;
Struct ObjectTable​
public struct ObjectTable<phantom K: copy, drop, store, phantom V: key, store> has key, store
Fields
- id: sui::object::UID
- the ID of this table
- size: u64
- the number of key-value pairs in the table
Constants​
const ETableNotEmpty: u64 = 0;
Function new​
Creates a new, empty table
public fun new<K: copy, drop, store, V: key, store>(ctx: &mut sui::tx_context::TxContext): sui::object_table::ObjectTable<K, V>
Function add​
Adds a key-value pair to the table table: &mut ObjectTable<K, V>
Aborts with sui::dynamic_field::EFieldAlreadyExists if the table already has an entry with
that key k: K.
public fun add<K: copy, drop, store, V: key, store>(table: &mut sui::object_table::ObjectTable<K, V>, k: K, v: V)
Function borrow​
Immutable borrows the value associated with the key in the table table: &ObjectTable<K, V>.
Aborts with sui::dynamic_field::EFieldDoesNotExist if the table does not have an entry with
that key k: K.
public fun borrow<K: copy, drop, store, V: key, store>(table: &sui::object_table::ObjectTable<K, V>, k: K): &V
Function borrow_mut​
Mutably borrows the value associated with the key in the table table: &mut ObjectTable<K, V>.
Aborts with sui::dynamic_field::EFieldDoesNotExist if the table does not have an entry with
that key k: K.
public fun borrow_mut<K: copy, drop, store, V: key, store>(table: &mut sui::object_table::ObjectTable<K, V>, k: K): &mut V
Function remove​
Removes the key-value pair in the table table: &mut ObjectTable<K, V> and returns the value.
Aborts with sui::dynamic_field::EFieldDoesNotExist if the table does not have an entry with
that key k: K.
public fun remove<K: copy, drop, store, V: key, store>(table: &mut sui::object_table::ObjectTable<K, V>, k: K): V
Function contains​
Returns true if there is a value associated with the key k: K in table table: &ObjectTable<K, V>
public fun contains<K: copy, drop, store, V: key, store>(table: &sui::object_table::ObjectTable<K, V>, k: K): bool
Function length​
Returns the size of the table, the number of key-value pairs
public fun length<K: copy, drop, store, V: key, store>(table: &sui::object_table::ObjectTable<K, V>): u64
Function is_empty​
Returns true if the table is empty (if length returns 0)
public fun is_empty<K: copy, drop, store, V: key, store>(table: &sui::object_table::ObjectTable<K, V>): bool
Function destroy_empty​
Destroys an empty table.
Aborts with ETableNotEmpty if the table still contains values
public fun destroy_empty<K: copy, drop, store, V: key, store>(table: sui::object_table::ObjectTable<K, V>)
Function value_id​
Returns the ID of the object associated with the key if the table has an entry with key k: K.
Returns none otherwise
public fun value_id<K: copy, drop, store, V: key, store>(table: &sui::object_table::ObjectTable<K, V>, k: K): std::option::Option<sui::object::ID>