Zig

Monitor FTP Transfer Progress

Demonstrates the progress properties CurBytesReceived, CurBytesReceivedStr, CurBytesSent, CurBytesSentStr, ProgressMonSize, PercentDoneScale, and AutoGetSizeForProgress.

Note: The local paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Percentage progress needs a known total, but FTP does not always report a file's size up front — so AutoGetSizeForProgress issues a SIZE command before a download, and ProgressMonSize supplies an expected size when even that is unavailable (a one-shot value consumed by the next transfer). PercentDoneScale sets the resolution of progress callbacks. The current byte counts are exposed both as 32-bit integers and as strings, the string forms avoiding integer-width limits for very large transfers.

Chilkat Zig Downloads

Download Chilkat for Zig

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    const ftp = try chilkat.Ftp2.init();
    defer ftp.deinit();

    ftp.setHostname("ftp.example.com");
    ftp.setUsername("myFtpLogin");

    // Normally you would not hard-code the password in source.  You should instead obtain it
    // from an interactive prompt, environment variable, or a secrets vault.
    ftp.setPassword("myPassword");

    ftp.connect() catch {
        std.debug.print("{s}\n", .{try ftp.getLastErrorText(alloc)});
        return;
    };

    // AutoGetSizeForProgress sends a SIZE command before a download so percentage-based progress can
    // be computed.
    ftp.setAutoGetSizeForProgress(true);

    // PercentDoneScale sets the value representing one hundred percent in PercentDone callbacks.
    // 1000 gives tenth-of-a-percent resolution.
    ftp.setPercentDoneScale(1000);

    // ProgressMonSize is a one-shot expected size for the next download when the size is not
    // otherwise known.  It is consumed by the next download and reset to 0.
    ftp.setProgressMonSize(20485760);

    ftp.getFile("public_html/bigfile.zip", "qa_output/bigfile.zip") catch {
        std.debug.print("{s}\n", .{try ftp.getLastErrorText(alloc)});
        return;
    };

    // After a transfer, the current byte counts are available as 32-bit numbers or as strings (the
    // string forms avoid integer-size limits).
    std.debug.print("Bytes received: {d}\n", .{ftp.getCurBytesReceived()});
    std.debug.print("Bytes received (str): {s}\n", .{try ftp.getCurBytesReceivedStr(alloc)});
    std.debug.print("Bytes sent: {d}\n", .{ftp.getCurBytesSent()});
    std.debug.print("Bytes sent (str): {s}\n", .{try ftp.getCurBytesSentStr(alloc)});

    ftp.disconnect() catch {
        std.debug.print("{s}\n", .{try ftp.getLastErrorText(alloc)});
        return;
    };
}