VuoDictionary_VuoText_VuoText

Description

A mapping from keys to values.

(To be replaced with a generic VuoDictionary type in the future.)

Classes
struct	VuoDictionary_VuoText_VuoText
	A mapping from keys to values. More...

Functions
VuoDictionary_VuoText_VuoText	VuoDictionary_VuoText_VuoText_makeFromJson (json_object *js)
	Decodes the JSON object to create a new value. More...
json_object *	VuoDictionary_VuoText_VuoText_getJson (const VuoDictionary_VuoText_VuoText d)
	Encodes the value as a JSON object. More...
char *	VuoDictionary_VuoText_VuoText_getSummary (const VuoDictionary_VuoText_VuoText d)
	Returns a brief description of the value. More...
VuoDictionary_VuoText_VuoText	VuoDictionaryCreate_VuoText_VuoText (void)
	Creates an empty dictionary. More...
VuoText	VuoDictionaryGetValueForKey_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key)
	Returns the value mapped from key in the dictionary. More...
void	VuoDictionarySetKeyValue_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key, VuoText value)
	Sets the value mapped from key in the dictionary to value. More...
VuoDictionary_VuoText_VuoText	VuoDictionaryCreateWithLists_VuoText_VuoText (const VuoList_VuoText keys, const VuoList_VuoText values)
	Creates a dictionary consisting of the specified keys and values. More...
VuoDictionary_VuoText_VuoText	VuoDictionary_VuoText_VuoText_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoDictionary_VuoText_VuoText_getString (const VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoText_retain (VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoText_release (VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...

---

Class Documentation

VuoDictionary_VuoText_VuoText

struct VuoDictionary_VuoText_VuoText

Class Members
VuoList_VuoText	keys
char	unused	Todo: https://b33p.net/kosada/node/4124
VuoList_VuoText	values

Function Documentation

VuoDictionary_VuoText_VuoText_getJson()

struct json_object * VuoDictionary_VuoText_VuoText_getJson

(

const VuoDictionary_VuoText_VuoText

d

)

Encodes the value as a JSON object.

VuoDictionary_VuoText_VuoText_getString()

char* VuoDictionary_VuoText_VuoText_getString

(

const VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_getSummary()

char * VuoDictionary_VuoText_VuoText_getSummary

(

const VuoDictionary_VuoText_VuoText

d

)

Returns a brief description of the value.

(When this type is replaced with a generic VuoDictionary type, this function will be replaced with a nicer implementation, more like VuoList_getSummary().)

VuoDictionary_VuoText_VuoText_makeFromJson()

VuoDictionary_VuoText_VuoText VuoDictionary_VuoText_VuoText_makeFromJson

(

json_object *

js

)

Decodes the JSON object to create a new value.

Example:

{
  "keys" : ["a","b","c"],
  "values" : [1.2, 3.4, 5.6]
}

VuoDictionary_VuoText_VuoText_makeFromString()

VuoDictionary_VuoText_VuoText VuoDictionary_VuoText_VuoText_makeFromString

(

const char *

str

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_release()

void VuoDictionary_VuoText_VuoText_release

(

VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_retain()

void VuoDictionary_VuoText_VuoText_retain

(

VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionaryCreate_VuoText_VuoText()

VuoDictionary_VuoText_VuoText VuoDictionaryCreate_VuoText_VuoText

(

void

)

Creates an empty dictionary.

VuoDictionaryCreateWithLists_VuoText_VuoText()

VuoDictionary_VuoText_VuoText VuoDictionaryCreateWithLists_VuoText_VuoText	(	const VuoList_VuoText	keys,
		const VuoList_VuoText	values
	)

Creates a dictionary consisting of the specified keys and values.

VuoDictionaryGetValueForKey_VuoText_VuoText()

VuoText VuoDictionaryGetValueForKey_VuoText_VuoText	(	VuoDictionary_VuoText_VuoText	d,
		VuoText	key
	)

Returns the value mapped from key in the dictionary.

In order to match, key must use the same Unicode character compositions as the dictionary's key.

VuoDictionarySetKeyValue_VuoText_VuoText()

void VuoDictionarySetKeyValue_VuoText_VuoText	(	VuoDictionary_VuoText_VuoText	d,
		VuoText	key,
		VuoText	value
	)

Sets the value mapped from key in the dictionary to value.

(Currently, this only allows adding a key-value mapping, not changing an existing one. When this type is replaced with a generic VuoDictionary type, this function will allow the latter.)