Zig

SFTP Get Size of File on Server

See more SFTP Examples

Demonstrates how to get the size of an existing file on the server. Zig

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

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

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    const sftp = try chilkat.SFtp.init();
    defer sftp.deinit();

    // Set some timeouts, in milliseconds:
    sftp.setConnectTimeoutMs(5000);
    sftp.setIdleTimeoutMs(10000);

    // Connect to the SSH server.
    // The standard SSH port = 22
    // The hostname may be a hostname or IP address.
    const hostname = "sftp.example.com";
    const port = 22;
    sftp.connect(hostname, port) catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    // Authenticate with the SSH server.  Chilkat SFTP supports
    // both password-based authenication as well as public-key
    // authentication.  This example uses password authenication.
    sftp.authenticatePw("myLogin", "myPassword") catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    // After authenticating, the SFTP subsystem must be initialized:
    sftp.initializeSftp() catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    // Assuming we know the file size won't be too large, we get the size as a 32-bit integer.
    // For SFTP, the remote file path is always either a path relative to the HOME directory of the user account, or an absolute path on the server.
    const b_follow_links = true;
    var b_is_handle: bool = false;
    var file_size: i32 = sftp.getFileSize32("someDir/someFile.dat", b_follow_links, b_is_handle);
    if (file_size < 0) {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    }

    std.debug.print("file size = {d}\n", .{file_size});

    // If the file size might be too large for a 32-bit signed integer, then get the size as a decimal string.
    // You can convert the string to a 64-bit integer in your programming language.
    const file_size_str = sftp.getFileSizeStr(alloc, "someDir/someFile.dat", b_follow_links, b_is_handle) catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("file size = {s}\n", .{file_size_str});

    // You can alternatively get the size with an open file handle.
    const handle = sftp.openFile(alloc, "someDir/someFile.dat", "readOnly", "openExisting") catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };

    // Get the size using the handle.
    b_is_handle = true;
    file_size = sftp.getFileSize32("someDir/someFile.dat", b_follow_links, b_is_handle);
    if (file_size < 0) {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    }

    std.debug.print("file size = {d}\n", .{file_size});

    // -----------------------------------------------------------------------------
    // Don't forget to close the file handle.
    // Otherwise open handles will accumulate on the server until eventually a limit
    // is reached and the server will fail on a call to OpenFile.
    // -----------------------------------------------------------------------------

    // Close the file.
    sftp.closeHandle(handle) catch {
        std.debug.print("{s}\n", .{try sftp.getLastErrorText(alloc)});
        return;
    };
}