carb/dictionary/ISerializer.h

↰ Parent directory: carb/dictionary/

Interface to handle serializing data from a file format into an carb::dictionary::IDictionary item. This interface is currently implemented in two plugins, each offering a different input/output format - JSON and TOML. The plugins are called carb.dictionary.serializer-json.plugin and carb.dictionary.serializer-toml.plugin. The caller must ensure they are using the appropriate one for their needs when loading, the plugin, acquiring the interface, and performing serialization operations (both to and from strings).

Source: carb/dictionary/ISerializer.h

Included By

• carb/dictionary/DictionaryUtils.h: Utility helper functions for common dictionary operations.

Namespaces

• carb: The main Carbonite namespace.

• carb::dictionary: Undocumented.

Classes

• carb::dictionary::ISerializer: Interface intended to serialize dictionary objects to and from plain C strings.

Typedefs

• carb::dictionary::DeserializerOptions: Flags for deserializing a string (for ISerializer::createDictionaryFromStringBuffer())

• carb::dictionary::SerializerOptions: Base type for flags for the ISerializer::createStringBufferFromDictionary() function.

Variables

• carb::dictionary::fDeserializerOptionInSitu: Flag that indicates that the const char* string value can actually be considered as char* and treated destructively (allow in-situ modification by the deserializer).

• carb::dictionary::fSerializerOptionEmptyDictionaryIsArray: Flag to indicate that if an empty dictionary item is found while walking the dictionary that is being serialized, it should be represented by an empty array.

• carb::dictionary::fSerializerOptionIncludeCollectionName: Deprecated flag name for carb::dictionary::fSerializerOptionIncludeDictionaryName.

• carb::dictionary::fSerializerOptionIncludeDictionaryName: Flags to affect the behavior of the ISerializer::createStringBufferFromDictionary() function.

• carb::dictionary::fSerializerOptionMakePretty: Flag to indicate that the generated string should be formatted to be human readable and look ‘pretty’.

• carb::dictionary::fSerializerOptionSerializeInfinityAsNull: Flag to indicate that the JSON serializer should write out infinity and NaN floating point values as a null object.

• carb::dictionary::kDeserializerOptionNone: Default value for carb::dictionary::DeserializerOptions that specifies no options.

• carb::dictionary::kSerializerOptionEmptyDictionaryIsArray: Deprecated flag.

• carb::dictionary::kSerializerOptionIncludeCollectionName: Deprecated flag.

• carb::dictionary::kSerializerOptionIncludeDictionaryName: Deprecated serializer option flag names.

• carb::dictionary::kSerializerOptionMakePretty: Deprecated flag.

• carb::dictionary::kSerializerOptionSerializeInfinityAsNull: Deprecated flag.