Compression Zig Reference Documentation
Compression
Current Version: 11.6.1
Chilkat.Compression
Supports
Work with byte arrays, strings,
Process data incrementally with
Return compressed bytes as text using encodings such as
Compress or decompress large files and streams with stable memory usage.
Combine compression and encryption in file workflows with integrated methods.
For an extended overview, see
Compression Class Overview.
See also
Binary Encodings
for supported encoded output formats.
Compress and decompress bytes, text, files, and streams with a flexible API.
Chilkat.Compression provides a general-purpose API for compressing
and decompressing data in memory, files, and streams. It supports multiple
algorithms, text charset conversion, encoded output, chunked processing, and
streaming operations for large data.
Multiple algorithms
deflate, zlib,
bzip2, and lzw.
Flexible data types
BinData,
StringBuilder, files, and streams.
Chunked processing
FirstChunk and
LastChunk for chunk-aware methods.
Encoded output
base64, hex, and others.
Streaming support
Compression + encryption
Charset = "utf-8" unless
another encoding is required. For encoded compressed data, set
EncodingMode to the desired output format.
Object Creation
// Add the package once:
// zig fetch --save https://chilkatdownload.com/11.6.1/chilkat-zig-11.6.1.tar.gz
// and in build.zig:
// const chilkat = b.dependency("chilkat", .{ .target = target, .optimize = optimize });
// exe.root_module.addImport("chilkat", chilkat.module("chilkat"));
const chilkat = @import("chilkat");
// Once per process, before any other Chilkat call:
try chilkat.unlockBundle("Anything for 30-day trial");
const compression = try chilkat.Compression.init();
defer compression.deinit();Creates the underlying native Chilkat object. Compression is a one-pointer struct passed by value; copying it copies the handle (two names for one object). Returns error.OutOfMemory if the library could not allocate the object. Use an object from one thread at a time; it may be handed from one thread to another.
Releases the native object. Call it exactly once per object (usually with defer); the handle is invalid afterwards. Objects returned by methods are owned by the caller too and are released the same way.
Wraps a handle obtained from the C API (chilkat.c.CkCompression), taking ownership of it. The struct's handle field goes the other way, for anything the Zig API does not cover.
Errors and memory
Methods that can fail return an error union: a method whose only outcome is success or failure returns Error!void; a method producing a string returns (Error || Allocator.Error)![:0]u8; a method producing an object returns Error!T. chilkat.Error is error{ChilkatFailed}; the reason for a failure is in getLastErrorText, and the object remains usable. Properties never fail, and methods that answer a question (hasMember, isUnlocked, ...) return a plain bool.
String arguments are [:0]const u8 (UTF-8; string literals can be passed as is). String results are copies allocated with the allocator argument and owned by the caller, so they stay valid across later calls on the same object.
const text = compression.someMethod(allocator, ...) catch |err| {
const why = try compression.getLastErrorText(allocator);
defer allocator.free(why);
std.debug.print("{s}\n", .{why});
return err;
};
defer allocator.free(text);Properties
Algorithm
pub fn getAlgorithm(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
pub fn setAlgorithm(self: Compression, value: [:0]const u8) void
Specifies the compression algorithm to use. Supported values are
deflate, zlib, bzip2, and lzw.
The zlib option is the deflate algorithm with a zlib header.
Note: ppmd is deprecated and should not be used.
It was only available on 32-bit systems and specifically used the J variant.
New applications should use one of the supported algorithms listed above.
Charset
pub fn getCharset(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
pub fn setCharset(self: Compression, value: [:0]const u8) void
Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.
The current default is the computer’s ANSI charset, such as Windows-1252 on many
Western Windows systems. However, most modern applications should explicitly set
this property to utf-8.
Recommendation: Set Charset = "utf-8" unless you
specifically need compatibility with another encoding.
DebugLogFilePath
pub fn getDebugLogFilePath(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: Compression, value: [:0]const u8) void
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DeflateLevel
pub fn getDeflateLevel(self: Compression) i32
pub fn setDeflateLevel(self: Compression, value: i32) void
Sets the compression level used by the deflate and zlib
algorithms.
0means no compression.9means maximum compression.- The default value is
6.
Higher values may produce smaller output but can require more processing time.
topEncodingMode
pub fn getEncodingMode(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
pub fn setEncodingMode(self: Compression, value: [:0]const u8) void
Specifies the text encoding used by methods whose names end in ENC,
such as CompressBytesENC and DecompressStringENC.
Compression methods ending in ENC return compressed binary data as
an encoded string. Decompression methods ending in ENC expect the
input string to use this same encoding.
Valid values include:
base64hexurlquoted-printable
FirstChunk
pub fn getFirstChunk(self: Compression) bool
pub fn setFirstChunk(self: Compression, value: bool) void
Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.
The default value is true
When both FirstChunk and LastChunk are
true
HeartbeatMs
pub fn getHeartbeatMs(self: Compression) i32
pub fn setHeartbeatMs(self: Compression, value: i32) void
Specifies the interval, in milliseconds, between AbortCheck event
callbacks.
This allows an application to periodically check whether a long-running operation should be aborted.
The default value is 0, which disables AbortCheck
callbacks.
LastChunk
pub fn getLastChunk(self: Compression) bool
pub fn setLastChunk(self: Compression, value: bool) void
Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.
The default value is true
When both FirstChunk and LastChunk are
true
LastErrorHtml
pub fn getLastErrorHtml(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
pub fn getLastErrorText(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
pub fn getLastErrorXml(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
pub fn getLastMethodSuccess(self: Compression) bool
pub fn setLastMethodSuccess(self: Compression, value: bool) void
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
UncommonOptions
pub fn getUncommonOptions(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
pub fn setUncommonOptions(self: Compression, value: [:0]const u8) void
Provides a way to enable specialized or uncommon behavior. This property normally remains empty.
It may be set to a comma-separated list of keywords.
Supported option:
-
Crypt2CompressHdr— Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.
VerboseLogging
pub fn getVerboseLogging(self: Compression) bool
pub fn setVerboseLogging(self: Compression, value: bool) void
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
pub fn getVersion(self: Compression, allocator: Allocator) Allocator.Error![:0]u8
Methods
CompressBd
Compresses the data contained in a BinData object.
The BinData object is modified to contain the compressed result.
This method is not FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressBd2
Compresses the data in one BinData object and appends the
compressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressEncryptFile
Compresses and encrypts a file, writing the result to a destination file.
The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressFile
Compresses a source file and writes the compressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressSb
Compresses the text contained in a StringBuilder and appends the
compressed bytes to a BinData object.
Text is converted to bytes according to the Charset property.
This method is FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressStream
Compresses data from a stream source and writes the compressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
CompressStringENC
Compresses a string and returns the compressed result as an encoded string.
The string is first converted to bytes using Charset, then
compressed, and finally encoded according to EncodingMode.
This method is not FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).
DecompressBd
Decompresses the compressed data contained in a BinData object.
The BinData object is modified to contain the decompressed result.
This method is not FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
DecompressBd2
Decompresses the data in one BinData object and appends the
decompressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
DecompressFile
Decompresses a source file and writes the decompressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
DecompressSb
Decompresses compressed data from a BinData object and appends the
resulting text to a StringBuilder.
The decompressed bytes are converted to text using the Charset
property.
This method is FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
DecompressStream
Decompresses data from a stream source and writes the decompressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
DecompressStringENC
Decompresses compressed data supplied as an encoded string and returns the resulting text.
The input string is decoded according to EncodingMode, then
decompressed. The resulting bytes are converted to text using
Charset.
This method is not FirstChunk / LastChunk aware.
Returns error.ChilkatFailed on failure; getLastErrorText explains why. The string is allocated with allocator and owned by the caller (defer allocator.free(s)).
DecryptDecompressFile
Decrypts and decompresses a file, writing the restored data to a destination file.
This is the reverse operation of CompressEncryptFile.
Returns error.ChilkatFailed on failure; getLastErrorText explains why.
Events
All Chilkat methods are synchronous: the call returns when the work is done. During a call, Compression raises three events so your program can show progress and offer a way out. Declare any subset of abortCheck, percentDone and progressInfo in a struct of your own and install a pointer to it with setEventHandler:
const Progress = struct {
pub fn percentDone(_: *Progress, pct: i32) bool {
std.debug.print("{d}%\n", .{pct});
return false; // return true to abort the method in progress
}
pub fn progressInfo(_: *Progress, name: [:0]const u8, value: [:0]const u8) void {
std.debug.print("{s}: {s}\n", .{ name, value });
}
};
var progress = Progress{};
compression.setEventHandler(&progress); // progress must outlive the installation
defer compression.clearEventHandler();
compression.setHeartbeatMs(250); // abortCheck 4 times per second during Chilkat callsInstalls handler, a pointer to any struct, as the receiver of this object's events, replacing any handler installed earlier. The dispatch is resolved at compile time: only the methods the struct declares are called, and a struct declaring none of the three is a compile error. The struct must stay alive, at the same address, until clearEventHandler or deinit.
Removes the handler; events are no longer delivered.
AbortCheck fires at regular intervals controlled by the HeartbeatMs property (0, the default, disables it); PercentDone fires when an operation's completion percentage is known; ProgressInfo delivers named progress values. Returning true from abortCheck or percentDone aborts the running method, which then returns error.ChilkatFailed.
Events fire on the thread that called the method, before that method returns. To abort a long operation from another thread, have abortCheck read a std.atomic.Value(bool), or set the object's AbortCurrent property.
AbortCheck
pub fn abortCheck(self: *T) bool
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
Example
const Abort = struct {
stop: std.atomic.Value(bool) = .init(false),
pub fn abortCheck(self: *Abort) bool {
return self.stop.load(.acquire); // another thread may call abort.stop.store(true, .release)
}
};
var abort = Abort{};
compression.setHeartbeatMs(250); // call abortCheck 4 times per second
compression.setEventHandler(&abort);
defer compression.clearEventHandler();PercentDone
pub fn percentDone(self: *T, pct: i32) bool
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
Example
const Progress = struct {
pub fn percentDone(_: *Progress, pct: i32) bool {
// pct ranges from 1 to 100.
std.debug.print("Percent done: {d}\n", .{pct});
return false; // return true to abort the method in progress
}
};
var progress = Progress{};
compression.setEventHandler(&progress);
defer compression.clearEventHandler();ProgressInfo
pub fn progressInfo(self: *T, name: [:0]const u8, value: [:0]const u8) void
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
Note: Some Chilkat methods don't fire any ProgressInfo events.
Example
const Info = struct {
pub fn progressInfo(_: *Info, name: [:0]const u8, value: [:0]const u8) void {
std.debug.print("{s}: {s}\n", .{ name, value });
}
};
var info = Info{};
compression.setEventHandler(&info);
defer compression.clearEventHandler();