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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! ftp is an FTP client written in Rust.
//!
//! ### Usage
//!
//! Here is a basic usage example:
//!
//! ```rust
//! use async_ftp::FtpStream;
//! async {
//!   let mut ftp_stream = FtpStream::connect("172.25.82.139:21").await.unwrap_or_else(|err|
//!       panic!("{}", err)
//!   );
//!   let _ = ftp_stream.quit();
//! };
//! ```
//!
//! ### FTPS
//!
//! The client supports FTPS on demand. To enable it the client should be
//! compiled with feature `openssl` enabled what requires
//! [openssl](https://crates.io/crates/openssl) dependency.
//!
//! The client uses explicit mode for connecting FTPS what means you should
//! connect the server as usually and then switch to the secure mode (TLS is used).
//! For better security it's the good practice to switch to the secure mode
//! before authentication.
//!
//! ### FTPS Usage
//!
//! ```rust,no_run
//! use std::path::Path;
//! use async_ftp::FtpStream;
//! use tokio_rustls::rustls::{ClientConfig, RootCertStore};
//! use tokio_rustls::webpki::{DNSName, DNSNameRef};
//!
//! async {
//!   let ftp_stream = FtpStream::connect("172.25.82.139:21").await.unwrap();
//!   
//!   let mut root_store = RootCertStore::empty();
//!   // root_store.add_pem_file(...);
//!   let mut conf = ClientConfig::new();
//!   conf.root_store = root_store;
//!   let domain = DNSNameRef::try_from_ascii_str("www.cert-domain.com").unwrap().into();
//!
//!   // Switch to the secure mode
//!   let mut ftp_stream = ftp_stream.into_secure(conf, domain).await.unwrap();
//!   ftp_stream.login("anonymous", "anonymous").await.unwrap();
//!   // Do other secret stuff
//!   // Switch back to the insecure mode (if required)
//!   let mut ftp_stream = ftp_stream.into_insecure().await.unwrap();
//!   // Do all public stuff
//!   let _ = ftp_stream.quit().await;
//! };
//! ```
//!

mod data_stream;
mod ftp;
pub mod status;
pub mod types;

pub use self::data_stream::DataStream;
pub use self::ftp::FtpStream;
pub use self::types::FtpError;