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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
use bytes::Bytes;
use http::header::CONTENT_TYPE;
use http_body_util::Empty;
use crate::http::StatusCode;
use crate::http::{HeaderMap, Version};
use super::body::raw::RawBody;
use super::body::TypedBody;
use super::ResponseBody;
/// Represents an HTTP response.
///
/// ```rust
/// use pavex::response::Response;
/// use pavex::http::{HeaderValue, header::SERVER};
///
/// // Create a new response with:
/// // - status code `OK`
/// // - HTTP version `HTTP/1.1`
/// // - the `Server` header set to `Pavex`
/// // - the `Content-Type` header set to `text/plain; charset=utf-8`
/// // - the body set to `Hello, world!`
/// let response = Response::ok()
/// .insert_header(SERVER, HeaderValue::from_static("Pavex"))
/// .set_typed_body("Hello, world!");
/// ```
///
/// The response is composed of a head ([`ResponseHead`]) and an optional body.
///
/// Check out [`Response::new`] for details on how to build a new [`Response`].
/// You might also want to check out the following methods to further customize
/// your response:
///
/// - [`set_status`](Response::set_status) to change the status code.
/// - [`set_version`](Response::set_version) to change the HTTP version.
/// - [`append_header`](Response::append_header) to append a value to a header.
/// - [`insert_header`](Response::insert_header) to upsert a header value.
/// - [`set_typed_body`](Response::set_typed_body) to set the body and automatically set the `Content-Type` header.
///
/// There are other methods available on [`Response`] that you might find useful, but the
/// ones listed above are the most commonly used and should be enough to get you started.
pub struct Response {
inner: http::Response<ResponseBody>,
}
#[non_exhaustive]
#[derive(Debug)]
/// All the information that is transmitted as part of an HTTP [`Response`] ahead of the body.
///
/// It includes the status code, the HTTP version, and the headers.
pub struct ResponseHead {
status: StatusCode,
version: Version,
headers: HeaderMap,
}
impl Response {
/// Build a new [`Response`] with the given status code.
/// The HTTP version is set to HTTP 1.1, there are no headers and
/// the body is empty.
///
/// # Example
///
/// ```rust
/// use pavex::http::StatusCode;
/// use pavex::response::Response;
///
/// let response = Response::new(StatusCode::OK);
/// ```
///
/// # Alternatives
///
/// Pavex's provides a set of shorthands for building a new [`Response`] using
/// well-known status code. For example, the following code is equivalent to the
/// example above:
///
/// ```rust
/// use pavex::response::Response;
///
/// let response = Response::ok();
/// ```
///
/// Check out [`Response`]'s API documentation for a complete list of all
/// the supported shorthands.
pub fn new(status_code: StatusCode) -> Self {
let inner = http::Response::new(ResponseBody::new(Empty::new()));
Self { inner }.set_status(status_code)
}
}
impl Response {
/// Change the status code of the [`Response`].
///
/// # Example
///
/// ```rust
/// use pavex::http::StatusCode;
/// use pavex::response::Response;
///
/// let mut response = Response::ok();
/// assert_eq!(response.status(), StatusCode::OK);
///
/// // Change the status code to `CREATED`.
/// response = response.set_status(StatusCode::CREATED);
/// assert_eq!(response.status(), StatusCode::CREATED);
/// ```
pub fn set_status(mut self, status: StatusCode) -> Self {
*self.inner.status_mut() = status;
self
}
/// Get a mutable reference to the [`Response`] status.
///
/// # Example
///
/// ```rust
/// use pavex::http::StatusCode;
/// use pavex::response::Response;
/// use pavex::http::header::CONTENT_TYPE;
///
/// let mut response = Response::ok();
///
/// assert_eq!(response.status(), StatusCode::OK);
///
/// // Get a mutable reference to the status.
/// let status = response.status_mut();
///
/// // Change the Status
/// *status = StatusCode::NOT_FOUND;
///
/// assert_eq!(response.status(), StatusCode::NOT_FOUND);
/// ```
pub fn status_mut(&mut self) -> &mut StatusCode {
self.inner.status_mut()
}
/// Change the HTTP version of the [`Response`].
///
/// # Example
///
/// ```rust
/// use pavex::http::Version;
/// use pavex::response::Response;
///
/// let mut response = Response::ok();
/// // By default, the HTTP version is HTTP/1.1.
/// assert_eq!(response.version(), Version::HTTP_11);
///
/// // Change the HTTP version to HTTP/2.
/// response = response.set_version(Version::HTTP_2);
/// assert_eq!(response.version(), Version::HTTP_2);
/// ```
pub fn set_version(mut self, version: Version) -> Self {
*self.inner.version_mut() = version;
self
}
/// Append a value to a [`Response`] header.
///
/// If the header is not present, it is added with the given value.
/// If the header is present, the value is appended to the end
/// of the comma-separated list of existing values for that header.
///
/// # Example
///
/// ```rust
/// use pavex::http::{header::HOST, HeaderValue};
/// use pavex::response::Response;
///
/// let mut response = Response::ok();
/// assert!(response.headers().get("host").is_none());
///
/// // Append a value to the `host` header.
/// let value = HeaderValue::from_static("world");
/// response = response.append_header(HOST, value);
///
/// let headers: Vec<_> = response.headers().get_all("host").iter().collect();
/// assert_eq!(headers.len(), 1);
/// assert_eq!(headers[0], "world");
///
/// // Append another value to the `host` header.
/// let value = HeaderValue::from_static("earth");
/// response = response.append_header(HOST, value);
///
/// let headers: Vec<_> = response.headers().get_all("host").iter().collect();
/// assert_eq!(headers.len(), 2);
/// assert_eq!(headers[0], "world");
/// assert_eq!(headers[1], "earth");
/// ```
///
/// # Alternatives
///
/// If you want to replace the value of a header instead of appending to it,
/// use [`insert_header`](Response::insert_header) instead.
pub fn append_header(
mut self,
key: crate::http::HeaderName,
value: crate::http::HeaderValue,
) -> Self {
self.inner.headers_mut().append(key, value);
self
}
/// Insert a header value into the [`Response`].
///
/// If the header key is not present, it is added with the given value.
/// If the header key is present, its value is replaced with the given value.
///
/// # Example
///
/// ```rust
/// use pavex::http::{header::HOST, HeaderValue};
/// use pavex::response::Response;
///
/// let mut response = Response::ok();
/// assert!(response.headers().get("host").is_none());
///
/// // Insert a value into the `host` header.
/// let value = HeaderValue::from_static("world");
/// response = response.insert_header(HOST, value);
///
/// let headers: Vec<_> = response.headers().get_all("host").iter().collect();
/// assert_eq!(headers.len(), 1);
/// assert_eq!(headers[0], "world");
///
/// // Insert another value into the `host` header.
/// let value = HeaderValue::from_static("earth");
/// response = response.insert_header(HOST, value);
///
/// let headers: Vec<_> = response.headers().get_all("host").iter().collect();
/// assert_eq!(headers.len(), 1);
/// assert_eq!(headers[0], "earth");
/// ```
///
/// # Alternatives
///
/// If you want to append to the current header value instead of replacing it,
/// use [`append_header`](Response::append_header) instead.
pub fn insert_header(
mut self,
key: crate::http::HeaderName,
value: crate::http::HeaderValue,
) -> Self {
self.inner.headers_mut().insert(key, value);
self
}
/// Set the [`Response`] body.
///
/// The provided body must implement the [`TypedBody`] trait.
/// The `Content-Type` header is automatically set to the value returned
/// by [`TypedBody::content_type`].
///
/// If a body is already set, it is replaced.
///
/// # Example
///
/// ```rust
/// use pavex::response::{Response, body::Html};
/// use pavex::http::header::CONTENT_TYPE;
///
/// let typed_body = "Hello, world!";
/// let response = Response::ok().set_typed_body(typed_body);
///
/// // The `Content-Type` header is set automatically
/// // when using `set_typed_body`.
/// assert_eq!(response.headers()[CONTENT_TYPE], "text/plain; charset=utf-8");
/// ```
///
/// # Built-in `TypedBody` implementations
///
/// Pavex provides several implementations of [`TypedBody`] out of the box,
/// to cover the most common use cases:
///
/// - [`String`], [`&'static str`](std::primitive::str)
/// and [`Cow<'static, str>`](std::borrow::Cow) for `text/plain; charset=utf-8` responses.
/// - [`Vec<u8>`], [`&'static [u8]`](std::primitive::u8),
/// [`Cow<'static, [u8]>`](std::borrow::Cow) and [`Bytes`] for `application/octet-stream` responses.
/// - [`Json`](crate::response::body::Json) for `application/json` responses.
/// - [`Html`](crate::response::body::Html) for `text/html; charset=utf-8` responses.
///
/// Check out the [`body`](super::body) sub-module for an exhaustive list.
///
/// # Raw body
///
/// If you don't want Pavex to automatically set the `Content-Type` header,
/// you might want to use [`Response::set_raw_body`] instead.
pub fn set_typed_body<NewBody>(self, body: NewBody) -> Response
where
NewBody: TypedBody,
<<NewBody as TypedBody>::Body as RawBody>::Error:
Into<Box<dyn std::error::Error + Send + Sync>>,
{
let (mut head, _) = self.inner.into_parts();
head.headers.insert(CONTENT_TYPE, body.content_type());
http::Response::from_parts(head, ResponseBody::new(body.body())).into()
}
/// Set the body of the [`Response`] to the given value, without setting
/// the `Content-Type` header.
///
/// This method should only be used if you need fine-grained control over
/// the `Content-Type` header or the body type. In all other circumstances, use
/// [`set_typed_body`](Response::set_typed_body).
///
/// # Example
///
/// ```rust
/// use pavex::response::Response;
/// use pavex::response::body::raw::{Bytes, Full};
/// use pavex::http::header::CONTENT_TYPE;
///
/// let raw_body: Full<Bytes> = Full::new("Hello, world!".into());
/// let response = Response::ok().set_raw_body(raw_body);
///
/// // The `Content-Type` header is not set automatically
/// // when using `set_raw_body`.
/// assert_eq!(response.headers().get(CONTENT_TYPE), None);
/// ```
pub fn set_raw_body<NewBody>(self, body: NewBody) -> Response
where
NewBody: RawBody<Data = Bytes> + Send + 'static,
<NewBody as RawBody>::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
{
let (head, _) = self.inner.into_parts();
http::Response::from_parts(head, ResponseBody::new(body)).into()
}
/// Get a mutable reference to the [`Response`] body.
pub fn body_mut(&mut self) -> &mut ResponseBody {
self.inner.body_mut()
}
/// Get a mutable reference to the [`Response`] headers.
///
/// # Example
///
/// ```rust
/// use pavex::response::Response;
/// use pavex::http::{header::CONTENT_TYPE, HeaderValue};
/// use mime::TEXT_PLAIN_UTF_8;
///
/// let mut response = Response::ok();
///
/// // Get a mutable reference to the headers.
/// let headers = response.headers_mut();
///
/// // Insert a header.
/// let value = HeaderValue::from_static(TEXT_PLAIN_UTF_8.as_ref());
/// headers.insert(CONTENT_TYPE, value);
///
/// assert_eq!(headers.len(), 1);
///
/// // Remove a header.
/// headers.remove(CONTENT_TYPE);
///
/// assert!(headers.is_empty());
/// ```
pub fn headers_mut(&mut self) -> &mut crate::http::HeaderMap {
self.inner.headers_mut()
}
}
impl Response {
/// Get a reference to the [`Response`] status code.
///
/// # Example
///
/// ```rust
/// use pavex::{http::StatusCode, response::Response};
///
/// let response = Response::bad_request();
/// assert_eq!(response.status(), StatusCode::BAD_REQUEST);
/// ```
///
/// # Mutation
///
/// Check out [`Response::set_status`] if you need to modify the
/// status code of the [`Response`].
pub fn status(&self) -> StatusCode {
self.inner.status()
}
/// Get a reference to the version of the HTTP protocol used by the [`Response`].
///
/// # Example
///
/// ```rust
/// use pavex::http::Version;
/// use pavex::response::Response;
///
/// let mut response = Response::ok();
/// // By default, the HTTP version is HTTP/1.1.
/// assert_eq!(response.version(), Version::HTTP_11);
/// ```
///
/// # Mutation
///
/// Check out [`Response::set_version`] if you need to modify the
/// HTTP protocol version used by the [`Response`].
pub fn version(&self) -> crate::http::Version {
self.inner.version()
}
/// Get a reference to the [`Response`] headers.
///
/// # Example
///
/// ```rust
/// use pavex::http::{header::{HOST, SERVER}, HeaderValue};
/// use pavex::response::Response;
///
/// let response = Response::ok()
/// .append_header(HOST, HeaderValue::from_static("world"))
/// .append_header(HOST, HeaderValue::from_static("earth"))
/// .insert_header(SERVER, HeaderValue::from_static("Pavex"));
///
/// let headers = response.headers();
/// assert_eq!(headers.len(), 3);
///
/// let host_values: Vec<_> = response.headers().get_all("host").iter().collect();
/// assert_eq!(host_values.len(), 2);
/// assert_eq!(host_values[0], "world");
/// assert_eq!(host_values[1], "earth");
///
/// assert_eq!(headers[SERVER], "Pavex");
/// ```
///
/// # Mutation
///
/// If you need to modify the [`Response`] headers, check out:
///
/// - [`Response::append_header`]
/// - [`Response::insert_header`]
/// - [`Response::headers_mut`]
pub fn headers(&self) -> &crate::http::HeaderMap {
self.inner.headers()
}
/// Get a reference to the [`Response`] body.
///
/// # Mutation
///
/// If you need to modify the [`Response`] body, check out:
///
/// - [`Response::set_typed_body`]
/// - [`Response::set_raw_body`]
/// - [`Response::body_mut`]
pub fn body(&self) -> &ResponseBody {
self.inner.body()
}
}
impl Response {
/// Break down the [`Response`] into its two components: the [`ResponseHead`]
/// and the body.
///
/// This method consumes the [`Response`].
///
/// # Related
///
/// You can use [`Response::from_parts`] to reconstruct a [`Response`] from
/// a [`ResponseHead`] and a body.
pub fn into_parts(self) -> (ResponseHead, ResponseBody) {
let (head, body) = self.inner.into_parts();
(head.into(), body)
}
/// Build a [`Response`] from its two components: the [`ResponseHead`]
/// and the body.
///
/// # Related
///
/// You can use [`Response::into_parts`] to decompose a [`Response`] from
/// a [`ResponseHead`] and a body.
pub fn from_parts(head: ResponseHead, body: ResponseBody) -> Self {
Self {
inner: http::Response::from_parts(head.into(), body),
}
}
}
impl<Body> From<http::Response<Body>> for Response
where
Body: Send + RawBody<Data = Bytes> + 'static,
<Body as RawBody>::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
{
fn from(inner: http::Response<Body>) -> Self {
let (head, body) = inner.into_parts();
let inner = http::Response::from_parts(head, ResponseBody::new(body));
Self { inner }
}
}
impl From<Response> for http::Response<ResponseBody> {
fn from(res: Response) -> Self {
res.inner
}
}
impl From<ResponseHead> for http::response::Parts {
fn from(head: ResponseHead) -> Self {
let ResponseHead {
status,
version,
headers,
} = head;
// Is there no better way to do create a new `Parts` instance?
let (mut parts, _) = http::response::Response::builder()
.body(Empty::<()>::new())
.unwrap()
.into_parts();
parts.status = status;
parts.version = version;
parts.headers = headers;
parts
}
}
impl From<http::response::Parts> for ResponseHead {
fn from(parts: http::response::Parts) -> Self {
let http::response::Parts {
status,
version,
headers,
..
} = parts;
Self {
status,
version,
headers,
}
}
}
macro_rules! shorthand {
($name:ident) => {
paste::paste! {
#[doc = "Start building a new [`Response`] with [`" $name "`](`StatusCode::" $name "`) as status code."]
pub fn [<$name:lower>]() -> Response {
Response::new(StatusCode::[<$name>])
}
}
};
}
/// Shorthand for building a new [`Response`] using a well-known status code.
impl Response {
/// Start building a new [`Response`] with [`CONTINUE`](StatusCode::CONTINUE) as status code.
// This is special-cased because `continue` is a keyword in Rust.
pub fn continue_() -> Response {
Response::new(StatusCode::CONTINUE)
}
// 2xx
shorthand!(SWITCHING_PROTOCOLS);
shorthand!(PROCESSING);
shorthand!(OK);
shorthand!(CREATED);
shorthand!(ACCEPTED);
shorthand!(NON_AUTHORITATIVE_INFORMATION);
shorthand!(NO_CONTENT);
shorthand!(RESET_CONTENT);
shorthand!(PARTIAL_CONTENT);
shorthand!(MULTI_STATUS);
shorthand!(ALREADY_REPORTED);
// 3xx
shorthand!(MULTIPLE_CHOICES);
shorthand!(MOVED_PERMANENTLY);
shorthand!(FOUND);
shorthand!(SEE_OTHER);
shorthand!(NOT_MODIFIED);
shorthand!(USE_PROXY);
shorthand!(TEMPORARY_REDIRECT);
shorthand!(PERMANENT_REDIRECT);
// 4xx
shorthand!(BAD_REQUEST);
shorthand!(NOT_FOUND);
shorthand!(UNAUTHORIZED);
shorthand!(PAYMENT_REQUIRED);
shorthand!(FORBIDDEN);
shorthand!(METHOD_NOT_ALLOWED);
shorthand!(NOT_ACCEPTABLE);
shorthand!(PROXY_AUTHENTICATION_REQUIRED);
shorthand!(REQUEST_TIMEOUT);
shorthand!(CONFLICT);
shorthand!(GONE);
shorthand!(LENGTH_REQUIRED);
shorthand!(PRECONDITION_FAILED);
shorthand!(PRECONDITION_REQUIRED);
shorthand!(PAYLOAD_TOO_LARGE);
shorthand!(URI_TOO_LONG);
shorthand!(UNSUPPORTED_MEDIA_TYPE);
shorthand!(RANGE_NOT_SATISFIABLE);
shorthand!(EXPECTATION_FAILED);
shorthand!(UNPROCESSABLE_ENTITY);
shorthand!(TOO_MANY_REQUESTS);
shorthand!(REQUEST_HEADER_FIELDS_TOO_LARGE);
shorthand!(UNAVAILABLE_FOR_LEGAL_REASONS);
// 5xx
shorthand!(INTERNAL_SERVER_ERROR);
shorthand!(NOT_IMPLEMENTED);
shorthand!(BAD_GATEWAY);
shorthand!(SERVICE_UNAVAILABLE);
shorthand!(GATEWAY_TIMEOUT);
shorthand!(HTTP_VERSION_NOT_SUPPORTED);
shorthand!(VARIANT_ALSO_NEGOTIATES);
shorthand!(INSUFFICIENT_STORAGE);
shorthand!(LOOP_DETECTED);
}