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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
//! [![Build status](https://img.shields.io/travis/Hexilee/roa/master.svg)](https://travis-ci.org/Hexilee/roa) //! [![codecov](https://codecov.io/gh/Hexilee/roa/branch/master/graph/badge.svg)](https://codecov.io/gh/Hexilee/roa) //! [![Rust Docs](https://docs.rs/roa-core/badge.svg)](https://docs.rs/roa-core) //! [![Crate version](https://img.shields.io/crates/v/roa-core.svg)](https://crates.io/crates/roa-core) //! [![Download](https://img.shields.io/crates/d/roa-core.svg)](https://crates.io/crates/roa-core) //! [![Version](https://img.shields.io/badge/rustc-1.39+-lightgray.svg)](https://blog.rust-lang.org/2019/11/07/Rust-1.39.0.html) //! [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Hexilee/roa/blob/master/LICENSE) //! //! ### Introduction //! //! Roa is an async web framework inspired by koajs, lightweight but powerful. //! //! ### Application //! //! A Roa application is a structure containing a middleware group which composes and executes middleware functions in a stack-like manner. //! //! The obligatory hello world application: //! //! ```rust,no_run //! use roa_core::App; //! use log::info; //! use std::error::Error as StdError; //! //! #[async_std::main] //! async fn main() -> Result<(), Box<dyn StdError>> { //! let mut app = App::new(()); //! app.end(|ctx| async move { //! ctx.resp_mut().await.write_str("Hello, World"); //! Ok(()) //! }); //! app.listen("127.0.0.1:8000", |addr| { //! info!("Server is listening on {}", addr) //! })? //! .await?; //! Ok(()) //! } //! ``` //! //! #### Cascading //! //! The following example responds with "Hello World", however, the request flows through //! the `logging` middleware to mark when the request started, then continue //! to yield control through the response middleware. When a middleware invokes `next().await` //! the function suspends and passes control to the next middleware defined. After there are no more //! middleware to execute downstream, the stack will unwind and each middleware is resumed to perform //! its upstream behaviour. //! //! ```rust,no_run //! use roa_core::App; //! use log::info; //! use std::error::Error as StdError; //! use std::time::Instant; //! //! #[async_std::main] //! async fn main() -> Result<(), Box<dyn StdError>> { //! let mut app = App::new(()); //! app.gate_fn(|_ctx, next| async move { //! let inbound = Instant::now(); //! next().await?; //! info!("time elapsed: {} ms", inbound.elapsed().as_millis()); //! Ok(()) //! }); //! //! app.end(|ctx| async move { //! ctx.resp_mut().await.write_str("Hello, World"); //! Ok(()) //! }); //! app.listen("127.0.0.1:8000", |addr| { //! info!("Server is listening on {}", addr) //! })? //! .await?; //! Ok(()) //! } //! ``` //! //! ### Error Handling //! //! You can catch or straightly throw a Error returned by next. //! //! ```rust //! use roa_core::{App, throw}; //! use async_std::task::spawn; //! use http::StatusCode; //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn std::error::Error>> { //! let (addr, server) = App::new(()) //! .gate_fn(|ctx, next| async move { //! // catch //! if let Err(err) = next().await { //! // teapot is ok //! if err.status_code != StatusCode::IM_A_TEAPOT { //! return Err(err) //! } //! } //! Ok(()) //! }) //! .gate_fn(|ctx, next| async move { //! next().await?; // just throw //! unreachable!() //! }) //! .end(|_ctx| async move { //! throw!(StatusCode::IM_A_TEAPOT, "I'm a teapot!") //! }) //! .run_local()?; //! spawn(server); //! let resp = reqwest::get(&format!("http://{}", addr)).await?; //! assert_eq!(StatusCode::OK, resp.status()); //! Ok(()) //! } //! ``` //! //! #### error_handler //! App has an error_handler to handle `Error` thrown by the top middleware. //! This is the error_handler: //! //! ```rust //! use roa_core::{Context, Error, Result, Model, ErrorKind}; //! pub async fn error_handler<M: Model>(context: Context<M>, err: Error) -> Result { //! context.resp_mut().await.status = err.status_code; //! if err.expose { //! context.resp_mut().await.write_str(&err.message); //! } //! if err.kind == ErrorKind::ServerError { //! Err(err) //! } else { //! Ok(()) //! } //! } //! ``` //! //! The Error thrown by this error_handler will be handled by hyper. //! //! ### Use custom runtime. //! //! Use hyper::Server::builder to construct a hyper server with your custom runtime. //! //! #### Example //! ```rust,no_run //! use roa_core::{App, Server, AddrIncoming, Executor}; //! use std::future::Future; //! //! /// An implementation of hyper::rt::Executor based on tokio //! #[derive(Copy, Clone)] //! pub struct Exec; //! //! impl<F> Executor<F> for Exec //! where //! F: 'static + Send + Future, //! F::Output: 'static + Send, //! { //! #[inline] //! fn execute(&self, fut: F) { //! tokio::task::spawn(fut); //! } //! } //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn std::error::Error>> { //! let app = App::new(()); //! let server = Server::builder(AddrIncoming::bind("127.0.0.1:8080")?) //! .executor(Exec) //! .serve(app); //! server.await?; //! Ok(()) //! } //! ``` #![warn(missing_docs)] mod app; mod body; mod context; mod err; mod group; mod middleware; mod model; mod next; mod request; mod response; pub(crate) use app::AddrStream; #[doc(inline)] pub use app::{AddrIncoming, App}; #[doc(inline)] pub use body::{Body, Callback as BodyCallback}; #[doc(inline)] pub use context::{Bucket, Context, Variable}; #[doc(inline)] pub use err::{Error, ErrorKind, Result, ResultFuture}; #[doc(inline)] pub use middleware::Middleware; #[doc(inline)] pub use group::{join, join_all}; #[doc(inline)] pub use model::{Model, State}; pub(crate) use next::last; #[doc(inline)] pub use next::Next; #[doc(inline)] pub use request::Request; #[doc(inline)] pub use response::Response; pub use http::{header, StatusCode}; pub use async_trait::async_trait; pub use hyper::rt::Executor; pub use hyper::Server;