Rust

Open a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.OpenDir method, which opens a remote directory and returns a handle for reading its entries. The only argument is the directory path. Close the handle with CloseHandle when finished.

Background: Listing a directory in SFTP is a handle-based operation, mirroring file access: open the directory to get a handle, read its entries, then close it. The handle is passed to ReadDirListing to retrieve the names and attributes. As with file handles, the directory handle is a server-side resource that should be closed to avoid exhausting the server's limits.

Chilkat Rust Downloads

Download Chilkat for Rust

Rust


// Demonstrates the SFtp.OpenDir method, which opens a remote directory and returns a handle for
// reading its entries.  The only argument is the directory path.

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

// Connect, authenticate, and initialize the SFTP subsystem.
let port = 22;
if sftp.connect("sftp.example.com", port).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

// 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.
let password = "mySshPassword".to_string();

if sftp.authenticate_pw("mySshLogin", &password).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

if sftp.initialize_sftp().is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

// Open the remote directory.  OpenDir returns a handle string.
let Ok(handle) = sftp.open_dir("subdir") else {
    println!("{}", sftp.last_error_text());
    return;
};

println!("Opened directory, handle = {}", handle);

// The directory entries are read with ReadDirListing using this handle.

// Close the handle when finished.
if sftp.close_handle(&handle).is_err() {
    println!("{}", sftp.last_error_text());
    return;
}

sftp.disconnect();