rust_web_server/
lib.rs

1//! # rust-web-server
2//!
3//! A static file web server and HTTP toolkit written in Rust.
4//! Supports HTTP/3 (QUIC), HTTP/2, and HTTP/1.1.
5//!
6//! ## Use as a library
7//!
8//! Add to `Cargo.toml`:
9//!
10//! ```toml
11//! [dependencies]
12//! rust-web-server = "17"
13//! ```
14//!
15//! ## Quick start: add a custom route
16//!
17//! ```rust,no_run
18//! use rust_web_server::controller::Controller;
19//! use rust_web_server::request::{METHOD, Request};
20//! use rust_web_server::response::{Response, STATUS_CODE_REASON_PHRASE};
21//! use rust_web_server::range::Range;
22//! use rust_web_server::mime_type::MimeType;
23//! use rust_web_server::server::ConnectionInfo;
24//!
25//! pub struct PingController;
26//!
27//! impl Controller for PingController {
28//!     fn is_matching(request: &Request, _: &ConnectionInfo) -> bool {
29//!         request.method == METHOD.get && request.request_uri == "/ping"
30//!     }
31//!
32//!     fn process(_: &Request, mut response: Response, _: &ConnectionInfo) -> Response {
33//!         response.status_code = *STATUS_CODE_REASON_PHRASE.n200_ok.status_code;
34//!         response.reason_phrase = STATUS_CODE_REASON_PHRASE.n200_ok.reason_phrase.to_string();
35//!         response.content_range_list = vec![
36//!             Range::get_content_range(b"pong".to_vec(), MimeType::TEXT_PLAIN.to_string())
37//!         ];
38//!         response
39//!     }
40//! }
41//! ```
42//!
43//! See [DEVELOPER.md](https://github.com/bohdaq/rust-web-server/blob/main/DEVELOPER.md)
44//! for the full building blocks reference and use case examples.
45
46pub mod app;
47#[cfg(feature = "auth")]
48pub mod auth;
49#[cfg(feature = "http2")]
50pub mod async_state;
51pub mod session;
52pub mod sse;
53pub mod compression;
54pub mod cookie;
55pub mod error;
56pub mod extract;
57pub mod metrics;
58pub mod middleware;
59pub mod rate_limit;
60pub mod router;
61pub mod state;
62pub mod test_client;
63pub mod application;
64pub mod body;
65pub mod client_hint;
66pub mod controller;
67pub mod core;
68pub mod cors;
69pub mod entry_point;
70pub mod ext;
71pub mod header;
72pub mod http;
73pub mod json;
74pub mod language;
75pub mod log;
76pub mod mime_type;
77pub mod null;
78pub mod range;
79pub mod request;
80pub mod response;
81pub mod server;
82pub mod symbol;
83pub mod thread_pool;
84pub mod url;
85pub mod websocket;
86
87#[cfg(feature = "http2")]
88#[doc(hidden)]
89pub mod tls;
90
91#[cfg(feature = "http2")]
92#[doc(hidden)]
93pub mod h2_handler;
94
95#[cfg(feature = "http3")]
96#[doc(hidden)]
97pub mod h3_handler;
rust_web_server/lib.rs

rust_web_server/
lib.rs
