Skip to content

jiacai2050/zig-curl

Repository files navigation

zig-curl

https://github.com/jiacai2050/zig-curl/actions/workflows/CI.yml/badge.svg https://ci.codeberg.org/api/badges/13257/status.svg

Zig bindings to libcurl, a free and easy-to-use client-side URL transfer library.

This package is in its early stage, although the core functionality works right now, the API is still subject to changes.

zig-curl only support Zig master, any contribution is welcome. ⚒️

The vendored libraries consist of:

LibraryVersion
libcurl8.5.0
zlib1.3
mbedtls3.5.1

Usage

const curl = @import("curl");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer if (gpa.deinit() != .ok) @panic("leak");
    const allocator = gpa.allocator();

    const easy = try curl.Easy.init(allocator, .{});
    defer easy.deinit();

    const resp = try easy.get("http://httpbin.org/anything");
    defer resp.deinit();

    std.debug.print("Status code: {d}\nBody: {s}\n", .{
        resp.status_code,
        resp.body.items,
    });
}

See examples/basic.zig, examples/advanced.zig for more usage.

Installation

zig-curl support package introduced in Zig 0.11.

zig fetch --save=curl https://github.com/jiacai2050/zig-curl/archive/${COMMIT}.tar.gz

Replace ${COMMIT} with a real one, then in your build.zig, import the module like this:

const dep_curl = b.dependency("curl", .{});
exe.root_module.addImport("curl", dep_curl.module("curl"));
exe.linkLibC();

This library will link to a vendored libcurl by default, you can disable it and link to system-wide with this

const dep_curl = b.dependency("curl", .{ .link_vendor = false });
exe.linkSystemLibrary("curl");
exe.linkLibC();

Roadmap

  • [x] Currently only easy API is supported, support multi API.

License

MIT