Dictionary

Category: Built-In Types

Brief Description

Dictionary type.

Member Functions

void	clear ( )
bool	empty ( )
void	erase ( var key )
bool	has ( var key )
bool	has_all ( Array keys )
int	hash ( )
Array	keys ( )
int	parse_json ( String json )
int	size ( )
String	to_json ( )
Array	values ( )

Description

Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.

Member Function Description

void clear ( )

Clear the dictionary, removing all key/value pairs.

bool empty ( )

Return true if the dictionary is empty.

void erase ( var key )

Erase a dictionary key/value pair by key.

bool has ( var key )

Return true if the dictionary has a given key.

bool has_all ( Array keys )

Return true if the dictionary has all of the keys in the given array.

int hash ( )

Return a hashed integer value representing the dictionary contents.

Array keys ( )

Return the list of keys in the Dictionary.

int parse_json ( String json )

Parse JSON text to the dictionary. Return OK when successed or the error code when failed.

Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert every numerical values to float types.

int size ( )

Return the size of the dictionary (in pairs).

String to_json ( )

Return the dictionary as json text.

Array values ( )

Return the list of values in the Dictionary.