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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
//! Edge is a Web framework that is simple to use, with the most common things //! you need out of the box, and flexible, supporting both synchronous and asynchronous //! request handling styles; see below for examples. //! //! The crate exports the things that you often need from dependencies, such as headers (from `hyper`), //! cookies (from `cookie`) and JSON serialization (from `serde_json`). //! //! Please note that this is an early version, and the API is likely to evolve. //! //! ## Overview //! //! In Edge you must define an *application structure* that contains the state of your application. //! You instantiate a container around this application, and associate GET/POST/... requests //! with given URLs to methods of your application. The container handles the routing and //! delegates calls to the appropriate methods. //! //! Note that the state cannot be mutated, as is usual in Rust (and enforced by the underlying HTTP server //! this crate uses, a.k.a. Hyper). Use appropriate concurrent data structures if you need //! shared mutable variables: locks, mutexes, channels, etc. //! //! ## Why another Web framework in Rust? //! //! Because I wanted a simple Web framework with: //! //! 1. everything I needed out of the box, like cookies and forms and templating, without having to dig up third-party crates, //! 1. the possibility to describe my application as a struct, so that callbacks could use a state (even if just for configuration). //! //! We focus on integration rather than modularity. //! I hope you like this crate, if it misses something to fit your needs just open an issue or make a pull request! //! //! And please keep in mind that the framework is in a (very) early stage :-) //! //! ## Hello World //! //! The most basic application: no state, a single page that prints Hello, world! //! //! ```no_run //! extern crate edge; //! //! use edge::{Edge, Request, Response}; //! //! struct MyApp; //! impl MyApp { //! fn hello(&self, _req: &mut Request, mut res: Response) { //! res.content_type("text/plain"); //! res.send("Hello, world!") //! } //! } //! //! fn main() { //! let mut cter = Edge::new(MyApp); //! cter.get("/", MyApp::hello); //! cter.start("0.0.0.0:3000").unwrap(); //! } //! ``` //! //! ## Asynchronous handling //! //! Under the hood, Edge uses the asynchronous version of Hyper. This means that to get the maximum //! performance, you should avoid waiting in a handler, so that other requests //! can be served as soon as possible. In that example, the handler waits in a separate thread before sending //! the response. //! //! ```no_run //! extern crate edge; //! //! use edge::{Edge, Request, Response}; //! use std::thread; //! use std::time::Duration; //! //! struct MyApp; //! impl MyApp { //! fn hello(&self, _req: &mut Request, mut res: Response) { //! thread::spawn(move || { //! println!("waiting 1 second"); //! thread::sleep(Duration::from_secs(1)); //! //! res.content_type("text/plain"); //! res.send("Hello, world!") //! }); //! //! // the handler returns immediately without waiting for the thread //! } //! } //! //! fn main() { //! let mut cter = Edge::new(MyApp); //! cter.get("/", MyApp::hello); //! cter.start("0.0.0.0:3000").unwrap(); //! } //! ``` //! //! ## Templating //! //! Here our application has a version, still a single handler except this time //! it accepts any page name, and renders a Handlebars template. We're also //! setting a custom Server header. //! //! ```no_run //! extern crate edge; //! //! use edge::{Edge, Request, Response, Status}; //! use edge::header::Server; //! use std::collections::BTreeMap; //! //! struct MyApp { //! version: &'static str //! } //! //! impl MyApp { //! fn page_handler(&self, req: &mut Request, mut res: Response) { //! let mut data = BTreeMap::new(); //! data.insert("title", req.param("page").unwrap()); //! data.insert("version", self.version); //! //! res.content_type("text/html").header(Server(format!("Edge version {}", self.version))); //! res.render("views/page.hbs", data) //! } //! } //! //! fn main() { //! let app = MyApp { version: "0.1" }; //! let mut cter = Edge::new(app); //! cter.get("/:page", MyApp::page_handler); //! cter.start("0.0.0.0:3000").unwrap(); //! } //! ``` //! //! ## Using a shared mutable counter //! //! In this example, we use an atomic integer to track a counter. This shows a very basic //! kind of shared state for a handler. In practice, it's best to avoid using blocking //! mechanisms (locks, mutexes) in a handler directly. Prefer non-blocking calls, //! like channels' try_recv, or move blocking code in a separate thread, //! see the example for asynchronous handling above. //! //! ```no_run //! extern crate edge; //! //! use edge::{Edge, Request, Response, Status}; //! use std::sync::atomic::{AtomicUsize, Ordering}; //! //! struct MyApp { //! counter: AtomicUsize //! } //! //! impl MyApp { //! fn home(&self, _req: &mut Request, mut res: Response) { //! let visits = self.counter.load(Ordering::Relaxed); //! self.counter.store(visits + 1, Ordering::Relaxed); //! //! res.status(Status::Ok).content_type("text/plain"); //! res.send(format!("Hello, world! {} visits", visits)) //! } //! } //! //! fn main() { //! let app = MyApp { counter: AtomicUsize::new(0) }; //! let mut cter = Edge::new(app); //! cter.get("/", MyApp::home); //! cter.start("0.0.0.0:3000").unwrap(); //! } //! ``` extern crate hyper; extern crate url; extern crate handlebars; extern crate serde; extern crate serde_json; pub use hyper::header as header; pub use header::CookiePair as Cookie; pub use hyper::status::StatusCode as Status; pub use serde_json::value as value; use header::ContentLength; use hyper::{Control, Decoder, Encoder, Method, Next, Get, Post, Head, Delete}; use hyper::method::Method::Put; use hyper::net::HttpStream; use hyper::server::{Handler, HandlerFactory, Server}; use hyper::server::{Request as HttpRequest, Response as HttpResponse}; use std::io::{Read, Result, Write}; use std::sync::Arc; mod buffer; mod router; mod request; mod response; pub use request::Request; pub use response::Response; pub use router::Callback; use buffer::Buffer; use router::Router; use response::Resp; /// Structure for an Edge application. pub struct Edge<T: Send + Sync> { inner: Arc<T>, router: Arc<Router<T>> } impl<T: 'static + Send + Sync> Edge<T> { /// Creates an Edge application using the given inner structure. pub fn new(inner: T) -> Edge<T> { Edge { inner: Arc::new(inner), router: Arc::new(Router::new()) } } /// Registers a callback for the given path for GET requests. pub fn get(&mut self, path: &str, callback: Callback<T>) { self.insert(Get, path, callback); } /// Registers a callback for the given path for POST requests. pub fn post(&mut self, path: &str, callback: Callback<T>) { self.insert(Post, path, callback); } /// Registers a callback for the given path for PUT requests. pub fn put(&mut self, path: &str, callback: Callback<T>) { self.insert(Put, path, callback); } /// Registers a callback for the given path for DELETE requests. pub fn delete(&mut self, path: &str, callback: Callback<T>) { self.insert(Delete, path, callback); } /// Registers a callback for the given path for HEAD requests. pub fn head(&mut self, path: &str, callback: Callback<T>) { self.insert(Head, path, callback); } /// Inserts the given callback for the given method and given route. pub fn insert(&mut self, method: Method, path: &str, callback: Callback<T>) { let router = Arc::get_mut(&mut self.router).unwrap(); router.insert(method, path.into(), callback) } /// Starts a server. pub fn start(self, addr: &str) -> Result<()> { let server = Server::http(&addr.parse().unwrap()).unwrap(); server.handle(self).unwrap(); Ok(()) } } pub struct EdgeHandler<T: Send + Sync> { router: Arc<Router<T>>, app: Arc<T>, request: Option<Request>, body: Option<Buffer>, resp: Option<Arc<Resp>> } impl<T: 'static + Send + Sync> HandlerFactory<HttpStream> for Edge<T> { type Output = EdgeHandler<T>; fn create(&mut self, control: Control) -> EdgeHandler<T> { EdgeHandler { router: self.router.clone(), app: self.inner.clone(), request: None, body: None, resp: Some(Arc::new(Resp::new(control))) } } } fn is_response_done(resp_opt: &mut Option<Arc<Resp>>) -> bool { if let Some(ref mut arc) = *resp_opt { return Arc::get_mut(arc).is_some(); } false } impl<T: 'static + Send + Sync> EdgeHandler<T> { fn callback(&mut self) -> Next { let req = &mut self.request.as_mut().unwrap(); if let Some(callback) = self.router.find_callback(req) { let res = response::new(&self.resp); callback(&self.app, req, res); } else { println!("route not found for path {:?}", req.path()); let mut res = response::new(&self.resp); res.status(Status::NotFound); res.content_type("text/plain"); res.send(format!("not found: {:?}", req.path())); } if is_response_done(&mut self.resp) { println!("response done, return Next::write after callback"); Next::write() } else { // otherwise we ask the Response to notify us, and wait println!("response not done, return Next::wait after callback"); response::set_notify(&self.resp); Next::wait() } } } /// Implements Handler for our EdgeHandler. impl<T: 'static + Send + Sync> Handler<HttpStream> for EdgeHandler<T> { fn on_request(&mut self, req: HttpRequest) -> Next { println!("on_request"); match request::new(req) { Ok(req) => { self.body = match *req.method() { Put | Post => Some(match req.headers().get::<ContentLength>() { Some(&ContentLength(len)) => Buffer::with_capacity(len as usize), None => Buffer::new() }), _ => None }; self.request = Some(req); if self.body.is_some() { Next::read() } else { self.callback() } }, Err(error) => { let mut res = response::new(&self.resp); res.status(Status::BadRequest); res.content_type("text/plain"); res.send(error.to_string()); Next::write() } } } fn on_request_readable(&mut self, transport: &mut Decoder<HttpStream>) -> Next { println!("on_request_readable"); // we can only get here if self.body = Some(...), or there is a bug { let body = self.body.as_mut().unwrap(); if let Some(next) = body.read(transport) { return next; } } // move body to the request request::set_body(self.request.as_mut(), self.body.take()); self.callback() } fn on_response(&mut self, res: &mut HttpResponse) -> Next { println!("on_response"); // we got here from callback directly or Resp notified the Control let resp = Arc::try_unwrap(self.resp.take().unwrap()).unwrap(); let (status, headers, body) = resp.deconstruct(); res.set_status(status); *res.headers_mut() = headers; if body.is_empty() { Next::end() } else { self.body = Some(body); Next::write() } } fn on_response_writable(&mut self, transport: &mut Encoder<HttpStream>) -> Next { println!("on_response_writable"); let body = self.body.as_mut().unwrap(); if body.is_empty() { // done writing the buffer println!("done writing"); Next::end() } else { // repeatedly write the body here with Next::write body.write(transport) } } }