ullun/lib.rs
1//! # ullun-api
2//!
3//! Express.js-inspired web framework for Rust.
4//!
5//! ## Quick Start
6//!
7//! ```no_run
8//! use ullun::prelude::*;
9//!
10//! #[tokio::main]
11//! async fn main() {
12//! App::new()
13//! .get_with_params("/hello/{name}", |params: Params| async move {
14//! Ok(Response::json(serde_json::json!({
15//! "message": format!("Hello, {}!", params.get("name").unwrap())
16//! })))
17//! })
18//! .run("127.0.0.1:3000")
19//! .await
20//! .unwrap();
21//! }
22//! ```
23
24//! ## Optional features
25//!
26//! | Feature | Adds |
27//! |---------|------|
28//! | `jwt` | `ullun::jwt` - HS256 tokens and bearer-auth middleware |
29//! | `compression` | `ullun::compression` - gzip middleware |
30//! | `websocket` | `App::ws` and `ullun::websocket` |
31//! | `full` | all of the above |
32//!
33//! Always available: [`rate_limit`], [`openapi`], [`template`], form parsing
34//! (`Request::form`) and group-level middleware.
35
36pub mod app;
37#[cfg(feature = "compression")]
38pub mod compression;
39pub mod conditional;
40pub mod cookies;
41pub mod error;
42pub mod handler;
43#[cfg(feature = "jwt")]
44pub mod jwt;
45pub mod middleware;
46pub mod openapi;
47pub mod rate_limit;
48pub mod request;
49pub mod response;
50pub mod router;
51pub mod security;
52pub mod shutdown;
53pub mod sse;
54pub mod static_files;
55pub mod stream;
56pub mod template;
57pub mod validate;
58#[cfg(feature = "websocket")]
59pub mod websocket;
60
61pub mod prelude {
62 pub use crate::app::{App, RouteGroup};
63 pub use crate::cookies::{Cookie, Cookies};
64 pub use crate::error::{Error, Result};
65 pub use crate::handler::Handler;
66 pub use crate::middleware::{Middleware, Next};
67 pub use crate::request::{Params, Query, Request};
68 pub use crate::response::{Json, Response};
69 pub use crate::router::Router;
70 pub use crate::shutdown::{Context, Shutdown};
71 pub use crate::template::{TemplateEngine, Templates};
72 pub use async_trait::async_trait;
73 pub use serde::{Deserialize, Serialize};
74}