Rust

SFTP Upload Large File in Parts

See more SFTP Examples

Demonstrates how to split a large file into N parts and then upload each part separately. This technique can be used to potentially avoid limits a SFTP server might impose on upload file size. 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;
}

// Open a remote file for writing on the SSH server.
// If the file already exists, it is overwritten.
// (Specify "createNew" instead of "createTruncate" to
// prevent overwriting existing files.)
let Ok(handle) = sftp.open_file("big.zip", "writeOnly", "createTruncate") else {
    println!("{}", sftp.last_error_text());
    return;
};

// We're going to upload the local file "qa_data/zips/big.zip" (a relative local path from our current working directory)
// to the SFTP server.
let local_file_path = "qa_data/zips/big.zip".to_string();

// Rather than uploading in one shot, we'll read the local file in chunks
// and upload a chunk at a time.
let fac = chilkat::FileAccess::new();

if fac.open_for_read(&local_file_path).is_err() {
    let _ = sftp.close_handle(&handle);
    println!("{}", fac.last_error_text());
    return;
}

// If we were to split the local file into 128K chunks, how many chunks (blocks) would
// we have, including the last partial block?
let block_size = 131072;
let num_blocks = fac.get_num_blocks(block_size);
println!("Number of blocks = {}", num_blocks);

let bd = chilkat::BinData::new();
let mut i = 0;
while i < num_blocks {
    // Read the Nth block, which gets appended to the bd.  (which means
    // we must clear the contents of bd before the next iteration)
    if fac.read_block_bd(i, block_size, &bd).is_err() {
        let _ = sftp.close_handle(&handle);
        println!("{}", fac.last_error_text());
        return;
    }

    // Upload this block to the open remote file.
    if sftp.write_file_bd(&handle, &bd).is_err() {
        println!("{}", sftp.last_error_text());
        return;
    }

    // Clear the contents for the next iteration.
    let _ = bd.clear();

    i = i + 1;
}

// Close the local file.
fac.file_close();

// -----------------------------------------------------------------------------
// This is important.  You must close the handle on the server.
// 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 remote file handle on the server.
if sftp.close_handle(&handle).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

println!("Success.");