aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib.rs
blob: f06332e0de6c06e6d26f3df7a80be7444887ba14 (plain)
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
#![warn(missing_docs)]

// Copyright (c) 2020  Teddy Wing
//
// This file is part of FastCGI-Conduit.
//
// FastCGI-Conduit is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// FastCGI-Conduit is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with FastCGI-Conduit. If not, see <https://www.gnu.org/licenses/>.

//! # fastcgi-conduit
//!
//! FastCGI-Conduit provides a [Conduit] interface to FastCGI, enabling a
//! high-level API for FastCGI applications.
//!
//!
//! ## Example
//!
//! ``` rust
//! use conduit::{header, Body, RequestExt, Response};
//! use fastcgi_conduit::Server;
//!
//!
//! fn main() {
//!     Server::start(handler);
//! }
//!
//! fn handler(_req: &mut dyn RequestExt) -> std::io::Result<Response<Body>> {
//!     Ok(
//!         Response::builder()
//!             .header(header::CONTENT_TYPE, "text/html")
//!             .body(Body::from_static(b"<h1>Hello</h1>"))
//!             .unwrap()
//!     )
//! }
//! ```
//!
//!
//! [Conduit]: ../conduit/index.html

extern crate conduit;
extern crate fastcgi;
extern crate http;
extern crate log;

mod request;
mod server;

pub use server::Server;