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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
use async_std::io::{self, BufRead, Read};
use std::fmt::{self, Debug};
use std::pin::Pin;
use std::task::{Context, Poll};
use crate::{mime, Mime};
pin_project_lite::pin_project! {
/// A streaming HTTP body.
///
/// `Body` represents the HTTP body of both `Request` and `Response`. It's completely
/// streaming, and implements `AsyncBufRead` to make reading from it both convenient and
/// performant.
///
/// Both `Request` and `Response` take `Body` by `Into<Body>`, which means that passing string
/// literals, byte vectors, but also concrete `Body` instances are all valid. This makes it
/// easy to create both quick HTTP requests, but also have fine grained control over how bodies
/// are streamed out.
///
/// # Examples
///
/// ```
/// use http_types::{Body, Response, StatusCode};
/// use async_std::io::Cursor;
///
/// let mut req = Response::new(StatusCode::Ok);
/// req.set_body("Hello Chashu");
///
/// let mut req = Response::new(StatusCode::Ok);
/// let cursor = Cursor::new("Hello Nori");
/// let body = Body::from_reader(cursor, Some(10)); // set the body length
/// req.set_body(body);
/// ```
///
/// # Length
///
/// One of the details of `Body` to be aware of is the `length` parameter. The value of
/// `length` is used by HTTP implementations to determine how to treat the stream. If a length
/// is known ahead of time, it's _strongly_ recommended to pass it.
///
/// Casting from `Vec<u8>`, `String`, or similar to `Body` will automatically set the value of
/// `length`.
///
/// # Content Encoding
///
/// By default `Body` will come with a fallback Mime type that is used by `Request` and
/// `Response` if no other type has been set, and no other Mime type can be inferred.
///
/// It's _strongly_ recommended to always set a mime type on both the `Request` and `Response`,
/// and not rely on the fallback mechanisms. However, they're still there if you need them.
pub struct Body {
#[pin]
reader: Box<dyn BufRead + Unpin + Send + Sync + 'static>,
mime: Mime,
length: Option<usize>,
}
}
impl Body {
/// Create a new empty `Body`.
///
/// The body will have a length of `0`, and the Mime type set to `application/octet-stream` if
/// no other mime type has been set or can be sniffed.
///
/// # Examples
///
/// ```
/// use http_types::{Body, Response, StatusCode};
///
/// let mut req = Response::new(StatusCode::Ok);
/// req.set_body(Body::empty());
/// ```
pub fn empty() -> Self {
Self {
reader: Box::new(io::empty()),
mime: mime::BYTE_STREAM,
length: Some(0),
}
}
/// Create a `Body` from a reader with an optional length.
///
/// The Mime type set to `application/octet-stream` if no other mime type has been set or can
/// be sniffed. If a `Body` has no length, HTTP implementations will often switch over to
/// framed messages such as [Chunked
/// Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Transfer-Encoding).
///
/// # Examples
///
/// ```
/// use http_types::{Body, Response, StatusCode};
/// use async_std::io::Cursor;
///
/// let mut req = Response::new(StatusCode::Ok);
///
/// let cursor = Cursor::new("Hello Nori");
/// let len = 10;
/// req.set_body(Body::from_reader(cursor, Some(len)));
/// ```
pub fn from_reader(
reader: impl BufRead + Unpin + Send + Sync + 'static,
len: Option<usize>,
) -> Self {
Self {
reader: Box::new(reader),
mime: mime::BYTE_STREAM,
length: len,
}
}
/// Get the length of the body in bytes.
///
/// # Examples
///
/// ```
/// use http_types::Body;
/// use async_std::io::Cursor;
///
/// let cursor = Cursor::new("Hello Nori");
/// let len = 10;
/// let body = Body::from_reader(cursor, Some(len));
/// assert_eq!(body.len(), Some(10));
/// ```
pub fn len(&self) -> Option<usize> {
self.length
}
/// Returns `true` if the body has a length of zero, and `false` otherwise.
pub fn is_empty(&self) -> Option<bool> {
self.length.map(|length| length == 0)
}
/// Get the inner reader from the `Body`
///
/// # Examples
///
/// ```
/// # use std::io::prelude::*;
/// use http_types::Body;
/// use async_std::io::Cursor;
///
/// let cursor = Cursor::new("Hello Nori");
/// let body = Body::from_reader(cursor, None);
/// let _ = body.into_reader();
/// ```
pub fn into_reader(self) -> Box<dyn BufRead + Unpin + Send + 'static> {
self.reader
}
/// Read the body as a string
///
/// # Examples
///
/// ```
/// # use std::io::prelude::*;
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
/// # async_std::task::block_on(async {
/// use http_types::Body;
/// use async_std::io::Cursor;
///
/// let cursor = Cursor::new("Hello Nori");
/// let body = Body::from_reader(cursor, None);
/// assert_eq!(&body.into_string().await.unwrap(), "Hello Nori");
/// # Ok(()) }) }
/// ```
pub async fn into_string(mut self) -> io::Result<String> {
use async_std::io::ReadExt;
let mut result = String::with_capacity(self.len().unwrap_or(0));
self.read_to_string(&mut result).await?;
Ok(result)
}
pub(crate) fn mime(&self) -> &Mime {
&self.mime
}
}
impl Debug for Body {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Body")
.field("reader", &"<hidden>")
.field("length", &self.length)
.finish()
}
}
impl From<String> for Body {
fn from(s: String) -> Self {
Self {
length: Some(s.len()),
reader: Box::new(io::Cursor::new(s.into_bytes())),
mime: string_mime(),
}
}
}
impl<'a> From<&'a str> for Body {
fn from(s: &'a str) -> Self {
Self {
length: Some(s.len()),
reader: Box::new(io::Cursor::new(s.to_owned().into_bytes())),
mime: string_mime(),
}
}
}
fn string_mime() -> mime::Mime {
let mut mime = mime::PLAIN;
let mut parameters = std::collections::HashMap::new();
parameters.insert("charset".to_owned(), "utf-8".to_owned());
mime.parameters = Some(parameters);
mime
}
impl From<Vec<u8>> for Body {
fn from(b: Vec<u8>) -> Self {
Self {
length: Some(b.len()),
reader: Box::new(io::Cursor::new(b)),
mime: mime::BYTE_STREAM,
}
}
}
impl Read for Body {
#[allow(missing_doc_code_examples)]
fn poll_read(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8],
) -> Poll<io::Result<usize>> {
Pin::new(&mut self.reader).poll_read(cx, buf)
}
}
impl BufRead for Body {
#[allow(missing_doc_code_examples)]
fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&'_ [u8]>> {
let this = self.project();
this.reader.poll_fill_buf(cx)
}
fn consume(mut self: Pin<&mut Self>, amt: usize) {
Pin::new(&mut self.reader).consume(amt)
}
}