Struct boluo_core::response::Response

pub struct Response<T = Body> { /* private fields */ }

HTTP响应。

HTTP响应由头部和可选的主体组成。主体是泛型的，允许任意类型来表示HTTP响应的主体。

Implementations

impl Response<()>

pub fn builder() -> ResponseBuilder

创建新的构建器以构建响应。

例子

use boluo_core::response::Response;

let response = Response::builder()
    .status(200)
    .header("X-Custom-Foo", "Bar")
    .body(())
    .unwrap();

impl<T> Response<T>

pub fn new(body: T) -> Response<T>

使用给定的主体创建一个空白的响应。

此响应的头部将被设置为默认值。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let mut response = Response::new("hello world");

assert_eq!(response.status(), StatusCode::OK);
assert_eq!(*response.body_mut(), "hello world");

pub fn from_parts(parts: ResponseParts, body: T) -> Response<T>

使用给定的头部和主体创建响应。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let response = Response::new("hello world");
let (mut parts, body) = response.into_inner();

parts.status = StatusCode::BAD_REQUEST;
let mut response = Response::from_parts(parts, body);

assert_eq!(response.status(), StatusCode::BAD_REQUEST);
assert_eq!(*response.body_mut(), "hello world");

pub fn status(&self) -> StatusCode

获取响应的状态码。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let response: Response<()> = Response::default();

assert_eq!(response.status(), StatusCode::OK);

pub fn status_mut(&mut self) -> &mut StatusCode

获取响应的状态码的可变引用。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let mut response: Response<()> = Response::default();
*response.status_mut() = StatusCode::CREATED;

assert_eq!(response.status(), StatusCode::CREATED);

pub fn version(&self) -> Version

获取响应的HTTP版本。

例子

use boluo_core::http::Version;
use boluo_core::response::Response;

let response: Response<()> = Response::default();

assert_eq!(response.version(), Version::HTTP_11);

pub fn version_mut(&mut self) -> &mut Version

获取响应的HTTP版本的可变引用。

例子

use boluo_core::http::Version;
use boluo_core::response::Response;

let mut response: Response<()> = Response::default();
*response.version_mut() = Version::HTTP_2;

assert_eq!(response.version(), Version::HTTP_2);

pub fn headers(&self) -> &HeaderMap<HeaderValue>

获取响应的标头集的引用。

例子

use boluo_core::response::Response;

let response: Response<()> = Response::default();

assert!(response.headers().is_empty());

pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue>

获取响应的标头集的可变引用。

例子

use boluo_core::http::header::*;
use boluo_core::response::Response;

let mut response: Response<()> = Response::default();
response.headers_mut().insert(HOST, HeaderValue::from_static("world"));

assert!(!response.headers().is_empty());

pub fn extensions(&self) -> &Extensions

获取响应的扩展的引用。

例子

use boluo_core::response::Response;

let response: Response<()> = Response::default();

assert!(response.extensions().get::<i32>().is_none());

pub fn extensions_mut(&mut self) -> &mut Extensions

获取响应的扩展的可变引用。

例子

use boluo_core::response::Response;

let mut response: Response<()> = Response::default();
response.extensions_mut().insert("hello");

assert_eq!(response.extensions().get(), Some(&"hello"));

pub fn body_mut(&mut self) -> &mut T

获取响应的主体的可变引用。

例子

use boluo_core::response::Response;

let mut response: Response<String> = Response::default();
response.body_mut().push_str("hello world");

assert!(!response.body_mut().is_empty());

pub fn into_body(self) -> T

消耗响应，返回响应的主体。

例子

use boluo_core::response::Response;

let response = Response::new(10);
let body = response.into_body();

assert_eq!(body, 10);

pub fn parts(&self) -> &ResponseParts

获取响应的头部的引用。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let response: Response<()> = Response::default();

assert_eq!(response.parts().status, StatusCode::OK);

pub fn parts_mut(&mut self) -> &mut ResponseParts

获取响应的头部的可变引用。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let mut response: Response<()> = Response::default();
response.parts_mut().status = StatusCode::CREATED;

assert_eq!(response.status(), StatusCode::CREATED);

pub fn into_parts(self) -> ResponseParts

消耗响应，返回响应的头部。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let response = Response::new(());
let parts = response.into_parts();

assert_eq!(parts.status, StatusCode::OK);

pub fn into_inner(self) -> (ResponseParts, T)

消耗响应，返回响应的头部和主体。

例子

use boluo_core::http::StatusCode;
use boluo_core::response::Response;

let response: Response<()> = Response::default();
let (parts, body) = response.into_inner();

assert_eq!(parts.status, StatusCode::OK);

pub fn map<F, U>(self, f: F) -> Response<U>

where F: FnOnce(T) -> U,

消耗响应，返回带有给定主体的新响应，其主体为传入闭包的返回值。

例子

use boluo_core::response::Response;

let response = Response::builder().body("some string").unwrap();
let mut mapped_response: Response<&[u8]> = response.map(|b| {
  assert_eq!(b, "some string");
  b.as_bytes()
});

assert_eq!(mapped_response.body_mut(), &"some string".as_bytes());

Trait Implementations

impl<T: Debug> Debug for Response<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default> Default for Response<T>

fn default() -> Response<T>

Returns the “default value” for a type.

impl<B> IntoResponse for Response<B>

where B: HttpBody<Data = Bytes> + Send + 'static, B::Error: Into<BoxError>,

type Error = Infallible

发生错误时返回的类型。

fn into_response(self) -> Result<Response, Self::Error>

得到一个Response实例。