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

//! This crate is my attempt at writting a FTP sync client
//! using Rust, it should contain most commands useful to
//! a regular client with ease of use. Additional internal
//! functionality is also exposed to avoid limiting the user
//! to the current implementation.
//!
//! Listing the files on the current working directory looks like
//! below when using this crate:
//! ```rust
//! use ftp_client::prelude::*;
//!
//! fn main() -> Result<(), ftp_client::error::Error> {
//!     let mut client = Client::connect("test.rebex.net", "demo", "password")?;
//!     let names = client.list_names("/")?;
//!     println!("Listing names: ");
//!     for name in names {
//!         println!("{}", name);
//!     }
//!     Ok(())
//! }
//! ```
//!
#![deny(missing_docs)]

pub mod client;
pub mod error;
pub mod status_code;

/// The prelude module contains some useful default imports.
pub mod prelude {
    pub use crate::client::Client;
    pub use crate::client::ClientMode;
    pub use crate::status_code::{StatusCode, StatusCodeKind};
}