ItemType#

Fully qualified name: carb::dictionary::ItemType

Defined in carb/dictionary/IDictionary.h

enum class carb::dictionary::ItemType#

Supported item types.

Values:

enumerator eBool#

Boolean value type.

Values of this type will be true or false. These values may be converted from numerical values where a 0 value is treated as false and any other value is treated as true. These may similarly be converted from string values that either are the strings true or false, or a numerical string.

enumerator eInt#

64-bit integer value type.

Values of this type can be any signed 64-bit integer. These values may be converted from other numerical types with a simple cast. Note however that converting from a floating point value that is out of range of a 64-bit integer will result in INT64_MIN being returned on x86_64 platforms. Integer items may be converted from a boolean value to get either 0 or 1. These may be converted from a string that contains only a numerical value. Other strings will convert to the value 0.

enumerator eFloat#

64-bit floating point value type.

Values of this type can be any signed 64-bit floating point value. These values may be converted from other numerical types with a simple cast. These may be converted from a boolean value to get either 0 or 1. These may be converted from a string that contains only a numerical value. Other strings will convert to the value 0.

enumerator eString#

String value type.

Values of this type can contain any string data, including multi-strings (ie: a string with internal null characters) or binary byte data. These values may be converted to numerical or boolean types if they contain the appropriate data and no extra characters (ie: “0.001purple” will not convert to a floating point value).

enumerator eDictionary#

Dictionary item type.

A dictionary is one that has zero or more children and no local item value. This type of item cannot be implicitly converted to any other data type and all value get operations on it will fail. This item type can also be treated as an array if it has one or more children whose names are consecutive non-negative integers starting at zero. An array item may still have other children with non-integer or non-consecutive names, but they will not be seen as being part of the array.

enumerator eCount#

The total number of item types.

This is not considered a valid item type but will be used as a return value from some IDictionary functions to indicate a failure or error condition.