FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kZstdStream_Construct ( kZstdStream zStream,
kStream  stream,
kZstdMode  mode,
k32s  level,
kAlloc  allocator 
)

Constructs a kZstdStream object.

The kZstdStream class requires that its underlying stream object (e.g., kFile) should provide a a read buffer (if read operations are to be performed). Configure the stream to allocate a read buffer before passing the stream to this constructor.

Parameters
zStreamDestination for the constructed object handle.
streamUnderlying stream; see note above on read buffer requirement.
modeSpecifies how to construct the stream (reading, writing or both).
levelCompression preset level for writing; accepts kZstdPreset, kCompressionPreset, or integer values.
allocatorMemory allocator (or kNULL for default).
Returns
Operation status.