Hashtable Zig Reference Documentation

Hashtable

Current Version: 11.6.1

Chilkat.Hashtable

Store, look up, remove, enumerate, import, and serialize key/value pairs.

Chilkat.Hashtable provides a simple key/value collection for storing string and integer values by key. It can add or replace entries, look up values, test whether keys exist, remove entries, count items, enumerate keys, import URL query parameters, serialize values back to a query string, and save or load the table in XML format.

String and integer values

Store values as strings or integers using straightforward add, replace, and lookup methods.

Fast key lookup

Check whether a key exists and retrieve its value without manually scanning a list or parsing text.

Add, replace, and remove

Maintain a mutable collection by adding new entries, replacing existing values, removing individual keys, or clearing the table.

Enumerate keys

Retrieve the set of keys when application logic needs to loop through the stored entries.

Query string helpers

Import URL query parameters into the table and serialize the table back to a query-string representation.

XML persistence

Save the hashtable to XML or reload it from XML when values need to be persisted or transferred in a simple structured format.

Common pattern: Use Hashtable when application code needs a small mutable key/value table, especially for lookup tables, parsed query parameters, or simple string/integer settings. Add values with AddStr or AddInt, retrieve them with LookupStr or LookupInt, and use XML or query-string methods when the table needs to be saved, loaded, or converted.

For an extended overview, see Hashtable Class 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 hashtable = try chilkat.Hashtable.init();
defer hashtable.deinit();

pub fn init() Allocator.Error!Hashtable

Creates the underlying native Chilkat object. Hashtable 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: Hashtable) 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.CkHashtable.HCkHashtable) Hashtable

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

Properties

Count

// read-only
pub fn getCount(self: Hashtable) i32

Introduced in version 9.5.0.97

The number of entries currently stored in the hashtable.

Each key contributes one entry regardless of whether its value is a string or an integer. Adding a new key increases Count; replacing the value of an existing key does not. Removing an entry decreases it, and Clear resets it to 0.

Term	Meaning
`Count`	The number of stored entries.
Capacity	The number of hash buckets, not a maximum entry count.

Hashtable Zig Reference Documentation

Hashtable

Current Version: 11.6.1

Store, look up, remove, enumerate, import, and serialize key/value pairs.

String and integer values

Fast key lookup

Add, replace, and remove

Enumerate keys

Query string helpers

XML persistence

Object Creation

Errors and memory

Properties

Count

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

VerboseLogging

Version

Methods

AddFromXmlSb

AddInt

AddQueryParams

AddStr

Clear

ClearWithNewCapacity

Contains

ContainsIntKey

GetKeys

LookupInt

LookupStr

Remove

ToQueryString

ToXmlSb