HttpRequest Zig Reference Documentation

HttpRequest

Current Version: 11.6.1

Chilkat.HttpRequest

Build structured HTTP requests for use with Chilkat.Http.

Chilkat.HttpRequest is a helper class for constructing HTTP requests that are sent by Chilkat.Http. It does not perform network communication on its own. Instead, it provides structured control over the request method, HTTP version, path, headers, query parameters, form parameters, content type, request body, multipart uploads, streamed file bodies, and diagnostic request generation.

Request construction

Build an HTTP request object with the method, path, version, headers, parameters, and body settings required by the target endpoint.

Form parameters

Add name/value parameters for form posts and API requests that expect structured form data.

Custom headers

Set request headers such as content type, accept headers, authorization headers, or application-specific metadata.

Request bodies

Provide body content for POST, PUT, PATCH, or other methods that send data to a server.

Multipart and file uploads

Construct multipart/form-data requests, attach file parts, or stream a file as the request body when the API requires upload content.

Diagnostics

Generate a textual representation of the request to inspect headers, paths, parameters, body structure, and upload formatting before sending.

Common pattern: Create a HttpRequest, set the HTTP method and path, add any headers, parameters, body data, or file parts, then pass the request object to the appropriate Chilkat.Http method for sending. Use HttpRequest for structured or multipart requests; use simpler Http methods directly when only a basic GET, POST, upload, or download is needed.

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

pub fn init() Allocator.Error!HttpRequest

Creates the underlying native Chilkat object. HttpRequest 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: HttpRequest) 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.CkHttpRequest.HCkHttpRequest) HttpRequest

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

Properties

Boundary

// read/write
pub fn getBoundary(self: HttpRequest, allocator: Allocator) Allocator.Error![:0]u8
pub fn setBoundary(self: HttpRequest, value: [:0]const u8) void

Introduced in version 9.5.0.49

Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.

More Information and Examples

HttpRequest Zig Reference Documentation

HttpRequest

Current Version: 11.6.1

Build structured HTTP requests for use with Chilkat.Http.

Request construction

Form parameters

Custom headers

Request bodies

Multipart and file uploads

Diagnostics

Object Creation

Errors and memory

Properties

Boundary

Charset

ContentType

DebugLogFilePath

EntireHeader

HttpVerb

HttpVersion

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumHeaderFields

NumParams

Path

SendCharset

VerboseLogging

Version

Methods

AddBdForUpload

AddFileForUpload

AddFileForUpload2

AddHeader

AddMwsSignature

AddParam

AddStringForUpload

AddStringForUpload2

AddSubHeader

GenerateRequestFile

GenerateRequestText

GetHeaderField

GetHeaderName

GetHeaderValue

GetParam

GetParamName

GetParamValue

GetUrlEncodedParams

LoadBodyFromBd

LoadBodyFromFile

LoadBodyFromSb

LoadBodyFromString

RemoveAllParams

RemoveHeader

RemoveParam

SetFromUrl

StreamBodyFromFile

StreamChunkFromFile