← Standard library

Dictionary

sealed class Dictionary<K, V> where K is Hashable

import Dictionary from Wax;

A mutable mapping from keys to values. Keys satisfy Hashable: equal keys must have equal hashes. Do not change a stored key's hash or equality behavior while it is in the dictionary. Assignment inserts or replaces; indexed reads throw ItemNotFoundError for absent keys. TryGetValue provides a lookup without that error and distinguishes absence from a stored null. Key and value arrays are snapshots in unspecified table order, not insertion order.

This example returns 1: the key exists even though its value is null.

import Dictionary from Wax;
api fn Main() : int32 {
    var names = new Dictionary<int32, string?>();
    names[7] = null;
    string? name;
    bool found = names.TryGetValue(7, out name);
    return found && name == null ? 1 : 0;
}

Dictionary.wax:45

Inherits from object. Follow these links for inherited members.

Members

public constructor ()

public constructor WithCapacity (int32 capacity)

public get size() : int32

public get capacity() : int32

public fn EnsureCapacity(int32 capacity) : void

public fn EnsureAdditionalCapacity(int32 additional) : void

public get this(K key) : V throws ItemNotFoundError

public set this(K key, V value) : void

public fn TryGetValue(K key, out V? value) : bool

public fn GetValue(K key) : V?

public fn Has(K key) : bool

public fn Remove(K key) : bool

public fn Clear() : void

public fn GetValueOrDefault(K key, V defaultValue) : V

public fn ContainsValue(V value) : bool where V is Equatable

public fn Keys() : K[]

public fn Values() : V[]