ZipEntry Zig Reference Documentation

ZipEntry

Current Version: 11.6.1

Chilkat.ZipEntry

Inspect, extract, update, and iterate individual entries inside a ZIP archive.

Chilkat.ZipEntry represents a single item associated with a Chilkat.Zip archive. An entry may be a file already stored in an opened ZIP, a referenced filesystem file waiting to be compressed, an in-memory text or binary entry, or a directory entry. It provides access to entry-level metadata, compressed and uncompressed data, timestamps, attributes, CRC values, encryption information, and extraction or replacement operations for that specific ZIP item.

Entry metadata

Inspect filenames, stored ZIP paths, comments, timestamps, CRC values, attributes, sizes, compression method, and compression level.

Entry type and state

Use EntryType to understand whether the entry comes from an existing ZIP, a filesystem reference, memory data, or a directory.

Extract one entry

Extract a selected file entry to disk, inflate its contents into memory, or read the uncompressed data into Chilkat objects.

Read compressed data

Access the raw compressed entry data when an application needs ZIP-level control rather than only the inflated contents.

Replace or append data

Update an entry's contents from strings, byte data, files, or in-memory data sources before writing the ZIP archive.

Iterate archive entries

Walk through entries returned from Chilkat.Zip methods to inspect, filter, extract, or modify ZIP contents one item at a time.

Common pattern: Open or create a Chilkat.Zip object, obtain a ZipEntry using methods such as EntryAt, EntryOf, EntryMatching, or FirstEntry, then inspect metadata, extract contents, update the entry, or continue iterating through the archive. Use Chilkat.Zip for whole-archive operations and ZipEntry for operations on one specific archive item.

For an extended overview, see ZipEntry Overview.

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 zip_entry = try chilkat.ZipEntry.init();
defer zip_entry.deinit();

pub fn init() Allocator.Error!ZipEntry

Creates the underlying native Chilkat object. ZipEntry 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.

pub fn deinit(self: ZipEntry) void

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.

pub fn fromHandle(h: *chilkat.c.CkZipEntry.HCkZipEntry) ZipEntry

Wraps a handle obtained from the C API (chilkat.c.CkZipEntry), 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 = zip_entry.someMethod(allocator, ...) catch |err| {
    const why = try zip_entry.getLastErrorText(allocator);
    defer allocator.free(why);
    std.debug.print("{s}\n", .{why});
    return err;
};
defer allocator.free(text);

Properties

Comment

// read/write
pub fn getComment(self: ZipEntry, allocator: Allocator) Allocator.Error![:0]u8
pub fn setComment(self: ZipEntry, value: [:0]const u8) void

Gets or sets the comment stored in the ZIP archive for this entry.

ZipEntry Zig Reference Documentation

ZipEntry

Current Version: 11.6.1

Inspect, extract, update, and iterate individual entries inside a ZIP archive.

Entry metadata

Entry type and state

Extract one entry

Read compressed data

Replace or append data

Iterate archive entries

Object Creation

Errors and memory

Properties

Comment

CompressedLength

CompressedLength64

CompressedLengthStr

CompressionLevel

CompressionMethod

Crc

DebugLogFilePath

EncryptionKeyLen

EntryID

EntryType

FileDateTimeStr

FileName

FileNameHex

HeartbeatMs

IsAesEncrypted

IsDirectory

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

TextFlag

UncompressedLength

UncompressedLength64

UncompressedLengthStr

VerboseLogging

Version

Methods

AppendString

CopyToBase64

CopyToHex

Extract

ExtractInto

GetNext

GetNextMatch

ReplaceString

SetDt

UnzipToBd

UnzipToSb

UnzipToStream

UnzipToString

Events

AbortCheck

PercentDone

ProgressInfo