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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
//! Viz
//!
//! Fast, robust, flexible, lightweight web framework for Rust.
//!
//! # Features
//!
//! * **Safety** `#![forbid(unsafe_code)]`
//!
//! * Lightweight
//!
//! * Simple + Flexible [`Handler`](#handler) & [`Middleware`](#middleware)
//!
//! * Handy [`Extractors`](#extractors)
//!
//! * Robust [`Routing`](#routing)
//!
//! * Supports Tower [`Service`]
//!
//! # Hello Viz
//!
//! ```no_run
//! use std::net::SocketAddr;
//! use tokio::net::TcpListener;
//! use viz::{serve, Request, Result, Router};
//!
//! async fn index(_: Request) -> Result<&'static str> {
//!     Ok("Hello, Viz!")
//! }
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
//!     let listener = TcpListener::bind(addr).await?;
//!     println!("listening on http://{addr}");
//!
//!     let app = Router::new().get("/", index);
//!
//!     if let Err(e) = serve(listener, app).await {
//!         println!("{e}");
//!     }
//!
//!     Ok(())
//! }
//! ```
//!
//! More examples can be found [here](https://github.com/viz-rs/viz/tree/main/examples).
//!
//!
//! # Handler
//!
//! A simple pattern `async fn(Request) -> Result<Response>` is used to handle requests in Viz.
//!
//! ## Simple handlers
//!
//! ```
//! # use viz::{IntoResponse, Request, Response, ResponseExt, Result};
//! async fn index(_: Request) -> Result<Response> {
//!     Ok(Response::text("Hello, World!"))
//! }
//!
//! async fn about(_: Request) -> Result<&'static str> {
//!     Ok("About Me!")
//! }
//!
//! async fn not_found(_: Request) -> Result<impl IntoResponse> {
//!     Ok("Not Found!")
//! }
//! ```
//!
//! ## Implemented Handler trait
//!
//! The types can implement the [`Handler`] trait to customize handlers.
//!
//! ```
//! # use std::sync::{Arc, atomic::{AtomicUsize, Ordering}};
//! # use viz::{async_trait, Handler, IntoResponse, Request, RequestExt, Response, Result};
//! #[derive(Clone)]
//! struct MyHandler {
//!     code: Arc<AtomicUsize>,
//! }
//!
//! #[async_trait]
//! impl Handler<Request> for MyHandler {
//!     type Output = Result<Response>;
//!
//!     async fn call(&self, req: Request) -> Self::Output  {
//!         let path = req.path();
//!         let method = req.method().clone();
//!         let code = self.code.fetch_add(1, Ordering::SeqCst);
//!         Ok(format!("code = {}, method = {}, path = {}", code, method, path).into_response())
//!     }
//! }
//! ```
//!
//! ## With extractors
//!
//! Supports handler with `zero` or `one` or `more` extractors.
//!
//! Extractors must implement the [`FromRequest`] trait for extracting data from the [`Request`].
//!
//! When joining the routing system, it should first be converted to a handler using
//! [`into_handler`][IntoHandler::into_handler].
//!
//! ```
//! # use viz::{get, types::Params, IntoResponse, IntoHandler, Result, Router};
//! async fn show_todo(Params(id): Params<u64>) -> Result<impl IntoResponse> {
//!     Ok(format!("Hi, NO.{}", id))
//! }
//!
//! let app = Router::new().route("/:id", get(show_todo.into_handler()));
//! ```
//!
//! ### Why not supports handler with extractors by default?
//!
//! Viz allows more flexibility in organizing your code.
//!
//! ```
//! # use viz::{
//! #   types::Params, IntoResponse, IntoHandler, Request, RequestExt, Result,
//! #   Response, Router, FnExt,
//! # };
//! async fn show_user(mut req: Request) -> Result<Response> {
//!     let Params(id)  = req.extract::<Params<u64>>().await?;
//!     Ok(format!("post {}", id).into_response())
//! }
//!
//! async fn show_user_ext(Params(id): Params<u64>) -> Result<impl IntoResponse> {
//!     Ok(format!("Hi, NO.{}", id))
//! }
//!
//! async fn show_user_wrap(req: Request) -> Result<impl IntoResponse> {
//!     // https://github.com/rust-lang/rust/issues/48919
//!     // show_user_ext.call(req).await
//!     FnExt::call(&show_user_ext, req).await
//! }
//!
//! let app = Router::new()
//!     .get("/users/:id", show_user)
//!     .get("/users_wrap/:id", show_user_wrap)
//!     .get("/users_ext/:id", show_user_ext.into_handler());
//! ```
//!
//! ### Support process macros?
//!
//! Support, you can enable the `macros` feature, using `#[handler]`.
//!
//! But it's still recommended to use `into_handler` for conversion.
//!
//! ```ignore
//! # use viz::{handler, types::Params, IntoHandler, IntoResponse, Result, Router};
//!
//! #[handler]
//! async fn show_user(Params(id): Params<u64>) -> Result<impl IntoResponse> {
//!     Ok(format!("Hi, NO.{}", id))
//! }
//!
//! async fn update_user(Params(id): Params<u64>) -> Result<impl IntoResponse> {
//!     Ok(format!("Updated, NO.{}", id))
//! }
//!
//! let app = Router::new()
//!     .get("/users/:id", show_user)
//!     .patch("/users/:id", update_user.into_handler());
//! ```
//!
//! ## Chaining and composing handlers
//!
//! The [`HandlerExt`] is an extension trait for [Handler]s that provides a variety of convenient
//! combinator functions.
//!
//! Likes the [`FutureExt`] and [`StreamExt`] traits.
//!
//! ```
//! # use viz::{
//! #   HandlerExt, IntoResponse, Request, Response, ResponseExt, Result, Router,
//! #   StatusCode, Method, Next, Handler
//! # };
//! async fn index(_: Request) -> Result<Response> {
//!     Ok(Response::text("hyper"))
//! }
//!
//! async fn before(req: Request) -> Result<Request> {
//!     if req.method() == Method::POST {
//!         Ok(req)
//!     } else {
//!         Err(StatusCode::METHOD_NOT_ALLOWED.into_error())
//!     }
//! }
//!
//! async fn around<H>((req, handler): Next<Request, H>) -> Result<Response>
//! where
//!     H: Handler<Request, Output = Result<Response>>,
//! {
//!     // before ...
//!     let result = handler.call(req).await;
//!     // after ...
//!     result
//! }
//!
//! async fn after(result: Result<Response>) -> Result<Response> {
//!     result.map(|mut res| {
//!         *res.status_mut() = StatusCode::NO_CONTENT;
//!         res
//!     })
//! }
//!
//! let routing = Router::new()
//!     .get("/", index.before(before).around(around).after(after));
//! ```
//!
//!
//! # Middleware
//!
//! Viz's middleware and handlers share a common [`Handler`] trait,
//! so its very easy to implement and extend the middleware.
//!
//! We can add middleware to a single handler, or to all handlers.
//!
//! We can also use [`Transform`] trait for wrapping the inner handler during construction.
//!
//! ```
//! # use std::time::Duration;
//! # use viz::{
//! #   async_trait, get, types::Params, Transform, HandlerExt, IntoResponse, IntoHandler,
//! #   Request, Response, ResponseExt, Result, Router, StatusCode, Next, Handler,
//! # };
//! async fn index(_: Request) -> Result<Response> {
//!     Ok(StatusCode::OK.into_response())
//! }
//!
//! async fn not_found(_: Request) -> Result<impl IntoResponse> {
//!     Ok(StatusCode::OK)
//! }
//!
//! async fn show_user(Params(id): Params<u64>) -> Result<impl IntoResponse> {
//!     Ok(format!("post {}", id))
//! }
//!
//! // middleware fn
//! async fn around<H>((req, handler): Next<Request, H>) -> Result<Response>
//! where
//!     H: Handler<Request, Output = Result<Response>>,
//! {
//!     // before ...
//!     let result = handler.call(req).await;
//!     // after ...
//!     result
//! }
//!
//! // middleware struct
//! #[derive(Clone)]
//! struct MyMiddleware {}
//!
//! #[async_trait]
//! impl<H> Handler<Next<Request, H>> for MyMiddleware
//! where
//!     H: Handler<Request>,
//! {
//!     type Output = H::Output;
//!
//!     async fn call(&self, (i, h): Next<Request, H>) -> Self::Output {
//!         h.call(i).await
//!     }
//! }
//!
//! // A configuration for Timeout Middleware
//! struct Timeout {
//!     delay: Duration,
//! }
//!
//! impl Timeout {
//!     pub fn new(secs: u64) -> Self {
//!         Self { delay: Duration::from_secs(secs) }
//!     }
//! }
//!
//! impl<H: Clone> Transform<H> for Timeout {
//!     type Output = TimeoutMiddleware<H>;
//!
//!     fn transform(&self, h: H) -> Self::Output {
//!         TimeoutMiddleware(h, self.delay)
//!     }
//! }
//!
//! // Timeout Middleware
//! #[derive(Clone)]
//! struct TimeoutMiddleware<H>(H, Duration);
//!
//! #[async_trait]
//! impl<H> Handler<Request> for TimeoutMiddleware<H>
//! where
//!     H: Handler<Request>,
//! {
//!     type Output = H::Output;
//!
//!     async fn call(&self, req: Request) -> Self::Output {
//!         self.0.call(req).await
//!     }
//! }
//!
//! let app = Router::new()
//!     .get("/", index
//!         // handler level
//!         .around(around)
//!         .around(MyMiddleware {})
//!         .with(Timeout::new(1))
//!     )
//!     .route("/users/:id", get(
//!         show_user
//!             .into_handler()
//!             .map_into_response()
//!             // handler level
//!             .around(around)
//!             .with(Timeout::new(0))
//!         )
//!         .post(
//!             (|_| async { Ok(Response::text("update")) })
//!             // handler level
//!             .around(around)
//!             .with(Timeout::new(0))
//!         )
//!         // route level
//!         .with_handler(MyMiddleware {})
//!         .with(Timeout::new(2))
//!     )
//!     .get("/*", not_found
//!         .map_into_response()
//!         // handler level
//!         .around(around)
//!         .around(MyMiddleware {})
//!     )
//!     // router level
//!     .with_handler(around)
//!     .with_handler(MyMiddleware {})
//!     .with(Timeout::new(4));
//! ```
//!
//!
//! # Extractors
//!
//! Extracts data from the [`Request`].
//!
//! ```
//! # use std::{cmp, convert::Infallible};
//! # use viz::{FromRequest, Request, RequestExt, Result};
//! struct Counter(u16);
//!
//! impl FromRequest for Counter {
//!     type Error = Infallible;
//!     async fn extract(req: &mut Request) -> Result<Self, Self::Error> {
//!         let c = get_query_param(req.query_string());
//!         Ok(Counter(c))
//!     }
//! }
//!
//! fn get_query_param(query: Option<&str>) -> u16 {
//!    let query = query.unwrap_or("");
//!    let q = if let Some(pos) = query.find('q') {
//!        query.split_at(pos + 2).1.parse().unwrap_or(1)
//!    } else {
//!        1
//!    };
//!    cmp::min(500, cmp::max(1, q))
//! }
//! ```
//!
//!
//! # Routing
//!
//! The Viz router recognizes URLs and dispatches them to a handler.
//!
//! ## Simple routes
//!
//! ```
//! # use viz::{get, Request, Route, Router, Response, Result, IntoResponse};
//! #
//! async fn index(_: Request) -> Result<Response> {
//!     Ok(().into_response())
//! }
//!
//! let root = Router::new()
//!   .get("/", index)
//!   .route("/about", get(|_| async { Ok("about") }));
//!
//! let search = Router::new()
//!   .route("/", Route::new().get(|_| async { Ok("search") }));
//! ```
//!
//! ## CRUD, Verbs
//!
//! Adds routes with the HTTP method.
//!
//! ```
//! # use viz::{
//! #   get, Request, RequestExt, Router,
//! #   Response, ResponseExt, Result, IntoResponse, types::Params
//! # };
//! #
//! async fn index_todos(_: Request) -> Result<impl IntoResponse> {
//!     Ok(())
//! }
//!
//! async fn create_todo(_: Request) -> Result<&'static str> {
//!     Ok("created")
//! }
//!
//! async fn new_todo(_: Request) -> Result<Response> {
//!     Ok(Response::html(r#"
//!         <form method="post" action="/">
//!             <input name="todo" />
//!             <button type="submit">Create</button>
//!         </form>
//!     "#))
//! }
//!
//! async fn show_todo(mut req: Request) -> Result<Response> {
//!     let Params(id): Params<u64> = req.extract().await?;
//!     Ok(Response::text(format!("todo's id is {}", id)))
//! }
//!
//! async fn update_todo(_: Request) -> Result<()> {
//!     Ok(())
//! }
//!
//! async fn destroy_todo(_: Request) -> Result<()> {
//!     Ok(())
//! }
//!
//! async fn edit_todo(_: Request) -> Result<()> {
//!     Ok(())
//! }
//!
//! let todos = Router::new()
//!   .route("/", get(index_todos).post(create_todo))
//!   .post("/new", new_todo)
//!   .route("/:id", get(show_todo).patch(update_todo).delete(destroy_todo))
//!   .get("/:id/edit", edit_todo);
//! ```
//!
//! ## Resources
//!
//! ```
//! # use viz::{get, Request, Resources, Response, ResponseExt, Result};
//! #
//! // GET `/search`
//! async fn search_users(_: Request) -> Result<Response> {
//!     Ok(Response::json::<Vec<u64>>(vec![])?)
//! }
//!
//! // GET `/`
//! async fn index_users(_: Request) -> Result<Response> {
//!     Ok(Response::json::<Vec<u64>>(vec![])?)
//! }
//!
//! // GET `/new`
//! async fn new_user(_: Request) -> Result<&'static str> {
//!     Ok("User Form")
//! }
//!
//! // POST `/`
//! async fn create_user(_: Request) -> Result<&'static str> {
//!     Ok("Created User")
//! }
//!
//! // GET `/user_id`
//! async fn show_user(_: Request) -> Result<&'static str> {
//!     Ok("User ID 007")
//! }
//!
//! // GET `/user_id/edit`
//! async fn edit_user(_: Request) -> Result<&'static str> {
//!     Ok("Edit User Form")
//! }
//!
//! // PUT `/user_id`
//! async fn update_user(_: Request) -> Result<&'static str> {
//!     Ok("Updated User")
//! }
//!
//! // DELETE `/user_id`
//! async fn delete_user(_: Request) -> Result<&'static str> {
//!     Ok("Deleted User")
//! }
//!
//! let users = Resources::default()
//!   .named("user")
//!   .route("/search", get(search_users))
//!   .index(index_users)
//!   .new(new_user)
//!   .create(create_user)
//!   .show(show_user)
//!   .edit(edit_user)
//!   .update(update_user)
//!   .destroy(delete_user);
//! ```
//!
//! ## Nested
//!
//! ```ignore
//! # use viz::{any, IntoResponse, Request, Result, Router, StatusCode};
//! async fn not_found(_: Request) -> Result<impl IntoResponse> {
//!     Ok(StatusCode::NOT_FOUND)
//! }
//!
//! let app = Router::new()
//!   .nest("/", root)
//!   .nest("/search", search)
//!   .nest("/todos", todos.clone())
//!   .nest("/users", users.nest("todos", todos))
//!   .route("/*", any(not_found));
//! ```
//!
//! [`FutureExt`]: https://docs.rs/futures/latest/futures/future/trait.FutureExt.html
//! [`StreamExt`]: https://docs.rs/futures/latest/futures/stream/trait.StreamExt.html
//! [`Service`]: https://docs.rs/tower-service/latest/tower_service/trait.Service.html

#![doc(html_logo_url = "https://viz.rs/logo.svg")]
#![doc(html_favicon_url = "https://viz.rs/logo.svg")]
#![doc(test(
    no_crate_inject,
    attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
))]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

mod responder;
pub use responder::Responder;

mod listener;
pub use listener::Listener;

mod server;
pub use server::{serve, Server};

#[cfg(any(feature = "native_tls", feature = "rustls"))]
pub use server::tls;

pub use viz_core::*;
pub use viz_router::*;

#[cfg(feature = "handlers")]
#[cfg_attr(docsrs, doc(cfg(feature = "handlers")))]
#[doc(inline)]
pub use viz_handlers as handlers;

#[cfg(feature = "macros")]
#[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
#[doc(inline)]
pub use viz_macros::handler;