Skip to main content

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 ObjectTableK, V has key, store
Click to open
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 newK, V(ctx: &mut sui::tx_context::TxContext): sui::object_table::ObjectTable<K, V>
Click to open
Implementation
public fun new<K: copy + drop + store, V: key + store>(ctx: &mut TxContext): ObjectTable<K, V> {
    ObjectTable {
        id: object::new(ctx),
        size: 0,
    }
}

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 addK, V(table: &mut sui::object_table::ObjectTable<K, V>, k: K, v: V)
Click to open
Implementation
public fun add<K: copy + drop + store, V: key + store>(table: &mut ObjectTable<K, V>, k: K, v: V) {
    ofield::add(&mut table.id, k, v);
    table.size = table.size + 1;
}

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 borrowK, V(table: &sui::object_table::ObjectTable<K, V>, k: K): &V
Click to open
Implementation
public fun borrow<K: copy + drop + store, V: key + store>(table: &ObjectTable<K, V>, k: K): &V {
    ofield::borrow(&table.id, k)
}

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_mutK, V(table: &mut sui::object_table::ObjectTable<K, V>, k: K): &mut V
Click to open
Implementation
public fun borrow_mut<K: copy + drop + store, V: key + store>(
    table: &mut ObjectTable<K, V>,
    k: K,
): &mut V {
    ofield::borrow_mut(&mut table.id, k)
}

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 removeK, V(table: &mut sui::object_table::ObjectTable<K, V>, k: K): V
Click to open
Implementation
public fun remove<K: copy + drop + store, V: key + store>(table: &mut ObjectTable<K, V>, k: K): V {
    let v = ofield::remove(&mut table.id, k);
    table.size = table.size - 1;
    v
}

Function contains​

Returns true iff there is a value associated with the key k: K in table table: &ObjectTable<K, V>

public fun containsK, V(table: &sui::object_table::ObjectTable<K, V>, k: K): bool
Click to open
Implementation
public fun contains<K: copy + drop + store, V: key + store>(table: &ObjectTable<K, V>, k: K): bool {
    ofield::exists_<K>(&table.id, k)
}

Function length​

Returns the size of the table, the number of key-value pairs

public fun lengthK, V(table: &sui::object_table::ObjectTable<K, V>): u64
Click to open
Implementation
public fun length<K: copy + drop + store, V: key + store>(table: &ObjectTable<K, V>): u64 {
    table.size
}

Function is_empty​

Returns true iff the table is empty (if length returns 0)

public fun is_emptyK, V(table: &sui::object_table::ObjectTable<K, V>): bool
Click to open
Implementation
public fun is_empty<K: copy + drop + store, V: key + store>(table: &ObjectTable<K, V>): bool {
    table.size == 0
}

Function destroy_empty​

Destroys an empty table Aborts with ETableNotEmpty if the table still contains values

public fun destroy_emptyK, V(table: sui::object_table::ObjectTable<K, V>)
Click to open
Implementation
public fun destroy_empty<K: copy + drop + store, V: key + store>(table: ObjectTable<K, V>) {
    let ObjectTable { id, size } = table;
    assert!(size == 0, ETableNotEmpty);
    id.delete()
}

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_idK, V(table: &sui::object_table::ObjectTable<K, V>, k: K): std::option::Option<sui::object::ID>
Click to open
Implementation
public fun value_id<K: copy + drop + store, V: key + store>(
    table: &ObjectTable<K, V>,
    k: K,
): Option<ID> {
    ofield::id(&table.id, k)
}