Client API

HTTP/HTTPS download client.

Type

pub const Client = struct {
    allocator: Allocator,
    config: Config,
    write_buffer: []u8,
};

Constructor

init

Initialize a new download client.

pub fn init(allocator: Allocator, config: Config) !Client

Parameters:

• allocator - Memory allocator for internal buffers
• config - Download configuration

Returns: Initialized Client or error

Example:

var client = try downloader.Client.init(allocator, .{
    .max_retries = 5,
    .resume_downloads = true,
});
defer client.deinit();

Destructor

deinit

Release all resources.

pub fn deinit(self: *Client) void

Example:

var client = try Client.init(allocator, .{});
defer client.deinit();

Methods

download

Download a file from URL.

pub fn download(
    self: *Client,
    url: []const u8,
    output_path: []const u8,
    callback: ?ProgressCallback,
) !u64

Parameters:

• url - HTTP or HTTPS URL
• output_path - Local file path
• callback - Progress callback (null for silent)

Returns: Total bytes downloaded

Errors:

• ConnectionFailed - Cannot connect
• ServerError - Server error response
• FileOpenError - Cannot write file
• RetriesExhausted - All retries failed
• Cancelled - Callback returned false

Example:

const bytes = try client.download(
    "https://example.com/file.zip",
    "file.zip",
    progressCallback
);

downloadSimple

Static convenience method.

pub fn downloadSimple(
    allocator: Allocator,
    url: []const u8,
    output_path: []const u8,
) !u64

Example:

const bytes = try Client.downloadSimple(allocator, url, "output.pdf");

Standalone Function

downloadFile

Module-level convenience function.

pub fn downloadFile(
    allocator: Allocator,
    url: []const u8,
    output_path: []const u8,
) !u64

Thread Safety

Client instances are not thread-safe. Create one Client per thread for concurrent downloads.

See Also

• Config - Configuration options
• Progress - Progress callbacks
• Errors - Error handling