shio 0.3.0

Shio is a fast, simple, and asynchronous micro web-framework for Rust.
Documentation 
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

use hyper::Body;

use response::Response;
use http::StatusCode;
use http::header::Header;

/// An HTTP response builder.
///
/// This type can be used to construct a [`Response`] through a builder-like pattern.
///
/// This builder may be finalized into a [`Response`] through either `Builder::body` or
/// `Builder::into`.
///
/// ```rust
/// # use shio::response::{self, Response};
/// # use shio::http::StatusCode;
/// // A 204, "No Content", Response
/// let response: Response = response::Builder::new().status(StatusCode::NoContent).into();
///
/// // A "Hello World" Response
/// let response: Response = response::Builder::new().body("Hello World\n");
/// ```
///
/// [`Response`]: struct.Response.html
#[derive(Default)]
pub struct Builder {
    inner: Response,
}

impl Builder {
    /// Creates a new default instance of `Builder` to construct a [`Response`].
    ///
    /// [`Response`]: struct.Response.html
    pub fn new() -> Self {
        Default::default()
    }

    /// Set the HTTP status for this response.
    ///
    /// ```rust
    /// # use shio::response::{self, Response};
    /// # use shio::http::StatusCode;
    /// let response: Response = response::Builder::new().status(StatusCode::BadRequest).into();
    /// ```
    #[inline]
    pub fn status(mut self, status: StatusCode) -> Self {
        self.inner.set_status(status);
        self
    }

    /// Appends a [`Header`] to this response.
    ///
    /// ```rust
    /// # use shio::response::{self, Response};
    /// # use shio::http::header;
    /// let response: Response = response::Builder::new()
    ///     // Date: Tue, 15 Nov 1994 08:12:31 GMT
    ///     .header(header::Date(std::time::SystemTime::now().into()))
    ///     // Content-Length: 30
    ///     .header(header::ContentLength(30))
    ///     // Server: Shio/0.0.4
    ///     .header(header::Server::new("Shio/0.0.4"))
    ///     .into();
    /// ```
    ///
    /// [`Header`]: ../trait.Header.html
    #[inline]
    pub fn header<H: Header>(mut self, header: H) -> Self {
        self.inner.headers_mut().set(header);
        self
    }

    /// Consumes this builder, using the provided body to return a constructed [`Response`].
    ///
    /// ```rust
    /// # use shio::response::{self, Response};
    /// let response: Response = response::Builder::new().body("Hello World\n");
    /// ```
    ///
    /// [`Response`]: struct.Response.html
    #[inline]
    pub fn body<B: Into<Body>>(mut self, body: B) -> Response {
        self.inner.set_body(body);
        self.inner
    }
}

impl From<Builder> for Response {
    fn from(builder: Builder) -> Self {
        builder.inner
    }
}