Struct Request

Source

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

Expand description

HTTP 请求。

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

Implementations§

Source §

impl Request<()>

Source

pub fn builder() -> RequestBuilder

创建新的构建器以构建请求。

§例子

use boluo_core::request::Request;

let request = Request::builder()
    .method("GET")
    .uri("https://www.rust-lang.org/")
    .header("X-Custom-Foo", "Bar")
    .body(())
    .unwrap();

Source §

impl<T> Request<T>

Source

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

使用给定的主体创建一个空白的请求。

此请求的头部将被设置为默认值。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let mut request = Request::new("hello world");

assert_eq!(*request.method(), Method::GET);
assert_eq!(*request.body_mut(), "hello world");

Source

pub fn from_parts(parts: RequestParts, body: T) -> Request<T>

使用给定的头部和主体创建请求。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

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

parts.method = Method::POST;
let mut request = Request::from_parts(parts, body);

assert_eq!(request.method(), Method::POST);
assert_eq!(*request.body_mut(), "hello world");

Source

pub fn method(&self) -> &Method

获取请求的 HTTP 方法的引用。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let request: Request<()> = Request::default();

assert_eq!(*request.method(), Method::GET);

Source

pub fn method_mut(&mut self) -> &mut Method

获取请求的 HTTP 方法的可变引用。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let mut request: Request<()> = Request::default();
*request.method_mut() = Method::PUT;

assert_eq!(*request.method(), Method::PUT);

Source

pub fn uri(&self) -> &Uri

获取请求的 URI 的引用。

§例子

use boluo_core::request::Request;

let request: Request<()> = Request::default();

assert_eq!(*request.uri(), "/");

Source

pub fn uri_mut(&mut self) -> &mut Uri

获取请求的 URI 的可变引用。

§例子

use boluo_core::request::Request;

let mut request: Request<()> = Request::default();
*request.uri_mut() = "/hello".parse().unwrap();

assert_eq!(*request.uri(), "/hello");

Source

pub fn version(&self) -> Version

获取请求的 HTTP 版本。

§例子

use boluo_core::http::Version;
use boluo_core::request::Request;

let request: Request<()> = Request::default();

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

Source

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

获取请求的 HTTP 版本的可变引用。

§例子

use boluo_core::http::Version;
use boluo_core::request::Request;

let mut request: Request<()> = Request::default();
*request.version_mut() = Version::HTTP_2;

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

Source

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

获取请求的标头集的引用。

§例子

use boluo_core::request::Request;

let request: Request<()> = Request::default();

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

Source

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

获取请求的标头集的可变引用。

§例子

use boluo_core::http::header::*;
use boluo_core::request::Request;

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

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

Source

pub fn extensions(&self) -> &Extensions

获取请求的扩展的引用。

§例子

use boluo_core::request::Request;

let request: Request<()> = Request::default();

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

Source

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

获取请求的扩展的可变引用。

§例子

use boluo_core::request::Request;

let mut request: Request<()> = Request::default();
request.extensions_mut().insert("hello");

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

Source

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

获取请求的主体的可变引用。

§例子

use boluo_core::request::Request;

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

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

Source

pub fn into_body(self) -> T

消耗请求，返回请求的主体。

§例子

use boluo_core::request::Request;

let request = Request::new(10);
let body = request.into_body();

assert_eq!(body, 10);

Source

pub fn parts(&self) -> &RequestParts

获取请求的头部的引用。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let request: Request<()> = Request::default();

assert_eq!(request.parts().method, Method::GET);

Source

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

获取请求的头部的可变引用。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let mut request: Request<()> = Request::default();
request.parts_mut().method = Method::PUT;

assert_eq!(*request.method(), Method::PUT);

Source

pub fn into_parts(self) -> RequestParts

消耗请求，返回请求的头部。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let request = Request::new(());
let parts = request.into_parts();

assert_eq!(parts.method, Method::GET);

Source

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

消耗请求，返回请求的头部和主体。

§例子

use boluo_core::http::Method;
use boluo_core::request::Request;

let request = Request::new(());
let (parts, body) = request.into_inner();

assert_eq!(parts.method, Method::GET);
assert_eq!(body, ());

Source

pub fn map<F, U>(self, f: F) -> Request
where F: FnOnce(T) -> U,

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

§例子

use boluo_core::request::Request;

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

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