tables

nimony/lib/std/tables.nim

• type Keyable = concept
    func ==(a: Self, b: Self): bool
    func hash(a: Self): uint64

• type Table = object
    data: seq[tuple[K, V]]
    hashes: seq

• func contains(t: Table[K,V]; k: K): bool

  True if k is stored in t.

• func hasKey(t: Table[K,V]; k: K): bool

  Alias for contains.

• func getOrDefault(t: Table[K,V]; k: K): V
• func getOrDefault(t: Table[K,V]; k: K; fallback: V): V

  Return t[k] if the key is present, otherwise fallback.

• func getOrQuit(t: Table[K,V]; k: K): var V

  Like [], but terminates the program if k is missing (after assert).

• func [](t: Table[K,V]; k: K): var V

  Retrieves k's value or raises KeyError when absent.

• func []=(t: var Table[K,V]; k: sink K; v: sink V)

  Inserts or updates k with v.

• func mgetOrPut(t: var Table[K,V]; k: sink K; v: sink V): var V

  Returns t[k], inserting v when k was missing; result is mutable.

• func len(t: Table[K,V]): int64

  Number of key/value pairs stored in t.

• iterator pairs(t: Table[K,V]): tuple[lent K, lent V]

  Yields every (key, value) stored in t.

• iterator mpairs(t: Table[K,V]): tuple[lent K, var V]

  Mutable variant of pairs (values can be updated in place).

• iterator keys(t: Table[K,V]): lent K
• iterator values(t: Table[K,V]): lent V
• iterator mvalues(t: var Table[K,V]): var V
• func del(t: var Table[K,V]; k: K)

  Remove k from t. No-op if absent. Preserves insertion order by shifting later entries down; the hash index is rebuilt afterwards because the shift renamed every entry's data position.

• func initTable(): Table[K,V]

  Creates an empty table.

• func clear(t: var Table[K,V])

  Remove all entries from t.

• type OrderedTable = Table[K,V]
• func initOrderedTable(): Table[K,V]