Zen API

- Home
- Topics
- Types
- Files

All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kDat5Serializer.h
Go to the documentation of this file.
1
10 #ifndef K_API_DAT5_SERIALIZER_H
11 #define K_API_DAT5_SERIALIZER_H
12
13 #include <kApi/kApiDef.h>
14 #include <kApi/Io/kDat5Serializer.x.h>
15
22 //typedef kSerializer kDat5Serializer; --forward-declared in kApiDef.x.h
23
33 kFx(kStatus) kDat5Serializer_Construct(kDat5Serializer* serializer, kStream stream, kAlloc allocator);
34
44 kFx(kStatus) kDat5Serializer_WriteData(kDat5Serializer serializer, kObject object, const kChar* label);
45
57 kFx(kStatus) kDat5Serializer_ReadData(kDat5Serializer serializer, kObject* object, kChar* label, kSize capacity, kAlloc allocator);
58
86 kFx(kStatus) kDat5Serializer_EnableCompression(kDat5Serializer serializer, kCompressionType algorithm, k32s level);
87
107 kFx(kStatus) kDat5Serializer_SaveCompressed(kObject object, const kChar* filePath, kCompressionType algorithm, k32s level);
108
109 #endif
kDat5Serializer::kDat5Serializer_WriteData
kStatus kDat5Serializer_WriteData(kDat5Serializer serializer, kObject object, const kChar *label)
Writes a labelled object to the underlying stream.
kSize
Represents an unsigned integer that can store a pointer address.
kAlloc
Abstract base class for memory allocator types.
kDat5Serializer::kDat5Serializer_Construct
kStatus kDat5Serializer_Construct(kDat5Serializer *serializer, kStream stream, kAlloc allocator)
Constructs a kDat5Serializer object.
kChar
Represents a single unit (byte) in a UTF-8 character.
kDat5Serializer::kDat5Serializer_SaveCompressed
kStatus kDat5Serializer_SaveCompressed(kObject object, const kChar *filePath, kCompressionType algorithm, k32s level)
Saves an object to file using the specified compression type.
kCompressionType
Type of compression algorithm.
kDat5Serializer::kDat5Serializer_EnableCompression
kStatus kDat5Serializer_EnableCompression(kDat5Serializer serializer, kCompressionType algorithm, k32s level)
Enables the use of compression in serialization.
kApiDef.h
Core Zen type declarations.
kStream
Represents an I/O stream.
k32s
Represents a 32-bit signed integer.
kDat5Serializer::kDat5Serializer_ReadData
kStatus kDat5Serializer_ReadData(kDat5Serializer serializer, kObject *object, kChar *label, kSize capacity, kAlloc allocator)
Reads a labelled object from the underlying stream.
kObject
Root of all Zen classes.
kStatus
Represents an error code.
kDat5Serializer
Serializes/deserializes objects using kDat5 format.