firetrap 0.1.0

Modern, safe and extensible FTP server library for Rust
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
41
42
43

#![deny(missing_docs)]
//! FTP server library for Rust
//!
//! Firetrap helps you create modern, safe and extensible FTP servers in Rust.
//!
//! Because of its plugable authentication and storage backends (e.g. local filesystem, Google
//! Buckets) it's more flexible than traditional FTP servers and a perfect match for the cloud.
//!
//! It is currently under heavy development and not yet recommended for production use.
//!
//! # Quick Start
//!
//! ```rust
//! extern crate firetrap;
//!
//! fn main() {
//!  let server = firetrap::Server::with_root(std::env::temp_dir());
//!  # if false { // We don't want to actually start the server in an example.
//!  server.listen("127.0.0.1:2121");
//!  # }
//! }
//! ```

#[macro_use]
extern crate log;
extern crate failure;
#[macro_use] extern crate failure_derive;
#[cfg(test)]
#[macro_use] extern crate pretty_assertions;

/// Contains the `Server` struct that is used to configure and control a FTP server instance.
pub mod server;
pub use server::Server;

pub(crate) mod commands;

/// Contains the `Authenticator` trait that is used by the `Server` to authenticate users, as well
/// as its various implementations.
pub mod auth;

/// Contains the `StorageBackend` trait that is by the `Server` and its various
/// implementations.
pub mod storage;