HttpResponse Zig Reference Documentation

HttpResponse

Current Version: 11.6.1

Chilkat.HttpResponse

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Chilkat.HttpResponse represents an HTTP response returned by certain Chilkat.Http methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as BinData, StringBuilder, JsonObject, JsonArray, and Xml.

Status and reason

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

Headers and cookies

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

Body as text or bytes

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

Structured body loading

Load the body directly into JsonObject, JsonArray, Xml, BinData, or StringBuilder objects for further processing.

Redirect information

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

Save and inspect responses

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

Common pattern: Send a request with Chilkat.Http, check the StatusCode, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, BinData, StringBuilder, JSON, or XML. Use HttpResponse for response inspection; use Chilkat.Http for the actual network request.

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

pub fn init() Allocator.Error!HttpResponse

Creates the underlying native Chilkat object. HttpResponse 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: HttpResponse) 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.CkHttpResponse.HCkHttpResponse) HttpResponse

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

Properties

BodyQP

// read-only
pub fn getBodyQP(self: HttpResponse, allocator: Allocator) Allocator.Error![:0]u8

The same as the Body property, but returned as a quoted-printable encoded string.

HttpResponse Zig Reference Documentation

HttpResponse

Current Version: 11.6.1

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Status and reason

Headers and cookies

Body as text or bytes

Structured body loading

Redirect information

Save and inspect responses

Object Creation

Errors and memory

Properties

BodyQP

BodyStr

Charset

ContentLength

ContentLength64

DateStr

DebugLogFilePath

Domain

FinalRedirectUrl

FullMime

Header

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCookies

NumHeaderFields

StatusCode

StatusLine

StatusText

UncommonOptions

VerboseLogging

Version

Methods

GetBodyBd

GetBodyJarr

GetBodyJson

GetBodySb

GetBodyXml

GetCookieDomain

GetCookieExpiresStr

GetCookieName

GetCookiePath

GetCookieValue

GetHeaderField

GetHeaderFieldAttr

GetHeaderName

GetHeaderValue

SaveBodyBinary

SaveBodyText

UrlEncParamValue