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.

json_object *	VuoDictionary_VuoText_VuoText_getJson (const VuoDictionary_VuoText_VuoText d)
	Encodes the value as a JSON object.

char *	VuoDictionary_VuoText_VuoText_getSummary (const VuoDictionary_VuoText_VuoText d)
	Returns a brief description of the value.

VuoDictionary_VuoText_VuoText	VuoDictionaryCreate_VuoText_VuoText (void)
	Creates an empty dictionary.

VuoText	VuoDictionaryGetValueForKey_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key)
	Returns the value mapped from key in the dictionary.

void	VuoDictionarySetKeyValue_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key, VuoText value)
	Sets the value mapped from key in the dictionary to value.

VuoDictionary_VuoText_VuoText	VuoDictionaryCreateWithLists_VuoText_VuoText (const VuoList_VuoText keys, const VuoList_VuoText values)
	Creates a dictionary consisting of the specified keys and values.

void	VuoDictionary_VuoText_VuoText_retain (VuoDictionary_VuoText_VuoText value)
	`VuoCompilerType::parseOrGenerateRetainOrReleaseFunction` can't currently generate this on arm64.

void	VuoDictionary_VuoText_VuoText_release (VuoDictionary_VuoText_VuoText value)
	`VuoCompilerType::parseOrGenerateRetainOrReleaseFunction` can't currently generate this on arm64.

char *	VuoDictionary_VuoText_VuoText_getString (const VuoDictionary_VuoText_VuoText value)
	Automatically generated function.

Class Documentation

◆ VuoDictionary_VuoText_VuoText

struct VuoDictionary_VuoText_VuoText

Class Members
VuoList_VuoText	keys
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.

Definition at line 63 of file VuoDictionary_VuoText_VuoText.cc.

◆ 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.

Definition at line 77 of file VuoDictionary_VuoText_VuoText.cc.

◆ 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]

}

Definition at line 45 of file VuoDictionary_VuoText_VuoText.cc.

◆ VuoDictionary_VuoText_VuoText_release()

void VuoDictionary_VuoText_VuoText_release ( VuoDictionary_VuoText_VuoText value )

VuoCompilerType::parseOrGenerateRetainOrReleaseFunction can't currently generate this on arm64.

https://b33p.net/kosada/vuo/vuo/-/issues/19142#note_2158967

Definition at line 174 of file VuoDictionary_VuoText_VuoText.cc.

◆ VuoDictionary_VuoText_VuoText_retain()

void VuoDictionary_VuoText_VuoText_retain ( VuoDictionary_VuoText_VuoText value )

VuoCompilerType::parseOrGenerateRetainOrReleaseFunction can't currently generate this on arm64.

https://b33p.net/kosada/vuo/vuo/-/issues/19142#note_2158967

Definition at line 164 of file VuoDictionary_VuoText_VuoText.cc.

◆ VuoDictionaryCreate_VuoText_VuoText()

VuoDictionary_VuoText_VuoText VuoDictionaryCreate_VuoText_VuoText ( void )

Creates an empty dictionary.

Definition at line 118 of file VuoDictionary_VuoText_VuoText.cc.

◆ 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.

Definition at line 126 of file VuoDictionary_VuoText_VuoText.cc.

◆ 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.

Definition at line 137 of file VuoDictionary_VuoText_VuoText.cc.

◆ 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.)

Definition at line 154 of file VuoDictionary_VuoText_VuoText.cc.