Url Zig Reference Documentation

Url

Current Version: 11.6.1

Chilkat.Url

Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.

Chilkat.Url is a focused URL parsing class. Given a full URL, it extracts the hostname, host type, login, password, path, query string, fragment, port, and SSL/TLS status into easy-to-read properties. It is useful when application code needs to inspect, validate, route, log, or pass URL parts to lower-level networking or API code.

Parse full URLs

Call ParseUrl to break a complete URL into structured properties that can be inspected individually.

Host and host type

Read the hostname and determine whether it is a DNS name, IPv4 address, or IPv6 address.

Path and query

Access the URL path, query string, and combined path-with-query value for request construction or routing.

Login and password

Extract embedded userinfo credentials when a URL contains a login and password component.

Port and TLS status

Determine the explicit or implied port and whether the URL represents an SSL/TLS connection.

Fragment handling

Read the URL fragment separately from the path and query for workflows that need anchor or client-side state information.

Common pattern: Use Url when the application needs to decompose a URL before making a request or applying custom logic. Parse the full URL, read the properties needed by the caller, then pass the relevant pieces to classes such as Chilkat.Http, Chilkat.Rest, or Chilkat.Socket. Use Url for parsing; use the higher-level networking classes to actually send the request.

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

pub fn init() Allocator.Error!Url

Creates the underlying native Chilkat object. Url 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: Url) 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.CkUrl.HCkUrl) Url

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

Properties

DebugLogFilePath

// read/write
pub fn getDebugLogFilePath(self: Url, allocator: Allocator) Allocator.Error![:0]u8
pub fn setDebugLogFilePath(self: Url, 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.

More Information and Examples

Url Zig Reference Documentation

Url

Current Version: 11.6.1

Parse a URL into its host, path, query, credentials, port, fragment, and TLS details.

Parse full URLs

Host and host type

Path and query

Login and password

Port and TLS status

Fragment handling

Object Creation

Errors and memory

Properties

DebugLogFilePath

Frag

Host

HostType

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Login

Password

Path

PathWithQueryParams

Port

Query

Scheme

Ssl

VerboseLogging

Version

Methods

ParseUrl