writium/lib.rs
1//! Writium Framework is the foundation of my blog generator Writium, and is
2//! separated from the generator project.
3//! It's a clean framework providing fundamental functionalities we always use.
4//!
5//! # Why Writium Framework?
6//!
7//! Writium Framework is not so versatile but it does its best to fulfill most
8//! of your needs, if *parts of* your web apps requires:
9//!
10//! * JSON ser/de;
11//! * chunk-based (rather than stream-based) interaction;
12//! * separation of duties;
13//! * hierarchic organization.
14//!
15//! Writium Framework works well with all web frameworks which can provide
16//! `HyperRequest`s and accept `HyperResponse`s, but itself is not a server
17//! to-go. It might bring you a few more codes to write, but such design allows
18//! you to separate the web engine and your API logics perfectly; it brings you
19//! flexibility you always want.
20//!
21//! For example, after finishing your RESTful API, and you find you have to
22//! write something stream-based. Then you can add it to somewhere in your same
23//! application; you don't need to port codes to another web framework simply
24//! because it doesn't support stream-based interaction.
25pub extern crate futures;
26pub extern crate hyper;
27#[macro_use]
28extern crate log;
29extern crate serde;
30extern crate serde_qs;
31extern crate serde_json;
32
33// Writium.
34mod writium;
35
36pub use writium::Writium;
37
38// Api and namespace.
39pub mod api;
40pub mod namespace;
41
42// Request flow protocol.
43pub mod proto;
44
45// Error handling.
46pub mod error;
47
48// Prelude.
49pub mod prelude;