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
33
34
35
36
37
38
39
40

//! Unified async remote file operations over **SMB**, **FTP**, and **SFTP**.
//!
//! Backends:
//! - 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`)
//!
//! # Quick start
//!
//! ```no_run
//! use remote_fs::{Client, FtpConfig, RemoteFileSystem};
//!
//! # #[tokio::main]
//! # async fn main() -> Result<(), remote_fs::Error> {
//! let cfg = FtpConfig::new("ftp.example.com", "user", "pass");
//! let mut client = Client::ftp(&cfg).await?;
//! let entries = client.list("/").await?;
//! client.write("/hello.txt", b"hello").await?;
//! client.disconnect().await?;
//! # Ok(())
//! # }
//! ```

mod client;
mod error;
mod ftp;
mod sftp;
mod smb;
mod traits;
mod types;

pub use client::{Client, ClientBuilder};
pub use error::{Error, Result};
pub use ftp::FtpClient;
pub use sftp::SftpClient;
pub use smb::SmbClient;
pub use traits::RemoteFileSystem;
pub use types::{
    Config, FileEntry, FileMeta, FtpConfig, Protocol, SftpConfig, SmbConfig,
};