Rust

SFTP Get Size of File on Server

See more SFTP Examples

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

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

let sftp = chilkat::SFtp::new();

// Set some timeouts, in milliseconds:
sftp.set_connect_timeout_ms(5000);
sftp.set_idle_timeout_ms(10000);

// Connect to the SSH server.  
// The standard SSH port = 22
// The hostname may be a hostname or IP address.
let hostname = "sftp.example.com".to_string();
let port = 22;
if sftp.connect(&hostname, port).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

// Authenticate with the SSH server.  Chilkat SFTP supports
// both password-based authenication as well as public-key
// authentication.  This example uses password authenication.
if sftp.authenticate_pw("myLogin", "myPassword").is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

// After authenticating, the SFTP subsystem must be initialized:
if sftp.initialize_sftp().is_err() {
    println!("{}", sftp.last_error_text());
    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.
let b_follow_links = true;
let mut b_is_handle = false;
let mut file_size = sftp.get_file_size32("someDir/someFile.dat", b_follow_links, b_is_handle);
if file_size < 0 {
    println!("{}", sftp.last_error_text());
    return;
}

println!("file size = {}", 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.
let Ok(file_size_str) = sftp.get_file_size_str("someDir/someFile.dat", b_follow_links, b_is_handle) else {
    println!("{}", sftp.last_error_text());
    return;
};

println!("file size = {}", file_size_str);

// You can alternatively get the size with an open file handle.
let Ok(handle) = sftp.open_file("someDir/someFile.dat", "readOnly", "openExisting") else {
    println!("{}", sftp.last_error_text());
    return;
};

// Get the size using the handle.
b_is_handle = true;
file_size = sftp.get_file_size32("someDir/someFile.dat", b_follow_links, b_is_handle);
if file_size < 0 {
    println!("{}", sftp.last_error_text());
    return;
}

println!("file size = {}", 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.
if sftp.close_handle(&handle).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}