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 csrf;
42pub mod error;
43pub mod files;
44pub mod handler;
45pub mod hub;
46pub mod jobs;
47#[cfg(feature = "jwt")]
48pub mod jwt;
49pub mod limits;
50pub mod middleware;
51pub mod multipart;
52pub mod observability;
53pub mod openapi;
54pub mod rate_limit;
55pub mod request;
56pub mod response;
57pub mod router;
58pub mod secure;
59pub mod security;
60pub mod session;
61pub mod shutdown;
62pub mod sse;
63pub mod static_files;
64pub mod stream;
65pub mod template;
66#[cfg(feature = "tls")]
67pub mod tls;
68pub mod validate;
69#[cfg(feature = "websocket")]
70pub mod websocket;
71
72pub mod prelude {
73    pub use crate::app::{App, RouteGroup};
74    pub use crate::cookies::{Cookie, Cookies};
75    pub use crate::error::{Error, Result};
76    pub use crate::handler::Handler;
77    pub use crate::middleware::{Middleware, Next};
78    pub use crate::request::{Params, Query, Request};
79    pub use crate::response::{Json, Response};
80    pub use crate::router::Router;
81    pub use crate::shutdown::{Context, Shutdown};
82    pub use crate::template::{TemplateEngine, Templates};
83    pub use async_trait::async_trait;
84    pub use serde::{Deserialize, Serialize};
85}
ullun/lib.rs

ullun/
lib.rs
