rust_web_server/controller/
mod.rs

1#[cfg(test)]
2mod example;
3
4use crate::request::Request;
5use crate::response::Response;
6use crate::server::ConnectionInfo;
7
8/// Core routing and handling trait. Implement this to add a route to the server.
9///
10/// # Example
11///
12/// ```rust,no_run
13/// use rust_web_server::controller::Controller;
14/// use rust_web_server::request::{METHOD, Request};
15/// use rust_web_server::response::{Response, STATUS_CODE_REASON_PHRASE};
16/// use rust_web_server::range::Range;
17/// use rust_web_server::mime_type::MimeType;
18/// use rust_web_server::server::ConnectionInfo;
19///
20/// pub struct HelloController;
21///
22/// impl Controller for HelloController {
23///     fn is_matching(request: &Request, _: &ConnectionInfo) -> bool {
24///         request.method == METHOD.get && request.request_uri == "/hello"
25///     }
26///
27///     fn process(_: &Request, mut response: Response, _: &ConnectionInfo) -> Response {
28///         response.status_code = *STATUS_CODE_REASON_PHRASE.n200_ok.status_code;
29///         response.reason_phrase = STATUS_CODE_REASON_PHRASE.n200_ok.reason_phrase.to_string();
30///         response.content_range_list = vec![
31///             Range::get_content_range(b"Hello!".to_vec(), MimeType::TEXT_PLAIN.to_string())
32///         ];
33///         response
34///     }
35/// }
36/// ```
37pub trait Controller {
38    /// Returns `true` if this controller should handle the given request.
39    /// Called in declaration order; the first match wins.
40    fn is_matching(request: &Request, connection: &ConnectionInfo) -> bool;
41
42    /// Produces the response. Receives the partially-built `response` (already populated
43    /// with standard headers from [`Header::get_header_list`]) and must return it populated
44    /// with a status code and body.
45    fn process(request: &Request, response: Response, connection: &ConnectionInfo) -> Response;
46}
rust_web_server/controller/mod.rs

rust_web_server/controller/
mod.rs
