remote-fs 0.1.0

Unified async file operations over SMB, FTP, and SFTP
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# remote-fs

Unified **async** file operations over SMB / FTP / SFTP.

## Backends

| Protocol | Crate |
|----------|-------|
| SMB | [`smb2`](https://crates.io/crates/smb2) |
| FTP | [`async-ftp`](https://crates.io/crates/async-ftp) |
| SFTP | [`async-ssh2-tokio`](https://crates.io/crates/async-ssh2-tokio) (+ `russh-sftp`) |

> Note: crates.io `tokio-ssh2` (0.0.1) is abandoned; `async-ssh2-tokio` is the maintained Tokio SSH/SFTP client.

## Usage

```rust
use remote_fs::{Client, FtpConfig, RemoteFileSystem, SmbConfig, SftpConfig};

#[tokio::main]
async fn main() -> remote_fs::Result<()> {
    let mut ftp = Client::ftp(&FtpConfig::new("ftp.example.com", "user", "pass")).await?;
    let mut sftp = Client::sftp(&SftpConfig::with_password("host", "user", "pass")).await?;
    let mut smb = Client::smb(&SmbConfig::new("host", "share", "user", "pass")).await?;

    let entries = ftp.list("/").await?;
    ftp.write("/demo.txt", b"hello").await?;
    ftp.download("/demo.txt", std::path::Path::new("./demo.txt")).await?;
    ftp.disconnect().await?;
    Ok(())
}
```