Struct RequestBuilder

pub struct RequestBuilder { /* private fields */ }

HTTP 请求的构建器。

Implementations

impl RequestBuilder

pub fn new() -> RequestBuilder

创建构建器的默认实例以构建请求。

例子

use boluo_core::request::RequestBuilder;

let req = RequestBuilder::new()
    .method("POST")
    .body(())
    .unwrap();

pub fn method<T>(self, method: T) -> RequestBuilder

where Method: TryFrom<T>, <Method as TryFrom<T>>::Error: Into<Error>,

设置请求的 HTTP 方法。

默认情况下，这是 GET。

例子

use boluo_core::request::Request;

let req = Request::builder()
    .method("POST")
    .body(())
    .unwrap();

pub fn method_ref(&self) -> Option<&Method>

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

默认情况下，这是 GET。如果构建器有错误，则返回 None。

例子

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

let mut req = Request::builder();
assert_eq!(req.method_ref(), Some(&Method::GET));

req = req.method("POST");
assert_eq!(req.method_ref(), Some(&Method::POST));

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

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

默认情况下，这是 GET。如果构建器有错误，则返回 None。

例子

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

let mut req = Request::builder();
assert_eq!(req.method_ref(), Some(&Method::GET));

*req.method_mut().unwrap() = Method::POST;
assert_eq!(req.method_ref(), Some(&Method::POST));

pub fn uri<T>(self, uri: T) -> RequestBuilder

where Uri: TryFrom<T>, <Uri as TryFrom<T>>::Error: Into<Error>,

设置请求的 URI。

默认情况下，这是 /。

例子

use boluo_core::request::Request;

let req = Request::builder()
    .uri("https://www.rust-lang.org/")
    .body(())
    .unwrap();

pub fn uri_ref(&self) -> Option<&Uri>

获取请求的 URI 的引用。

默认情况下，这是 /。如果构建器有错误，则返回 None。

例子

use boluo_core::request::Request;

let mut req = Request::builder();
assert_eq!(req.uri_ref().unwrap(), "/");

req = req.uri("https://www.rust-lang.org/");
assert_eq!(req.uri_ref().unwrap(), "https://www.rust-lang.org/");

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

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

默认情况下，这是 /。如果构建器有错误，则返回 None。

例子

use boluo_core::request::Request;

let mut req = Request::builder();
assert_eq!(req.uri_ref().unwrap(), "/");

*req.uri_mut().unwrap() = "https://www.rust-lang.org/".parse().unwrap();
assert_eq!(req.uri_ref().unwrap(), "https://www.rust-lang.org/");

pub fn version(self, version: Version) -> RequestBuilder

设置请求的 HTTP 版本。

默认情况下，这是 HTTP/1.1。

例子

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

let req = Request::builder()
    .version(Version::HTTP_2)
    .body(())
    .unwrap();

pub fn version_ref(&self) -> Option<&Version>

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

默认情况下，这是 HTTP/1.1。如果构建器有错误，则返回 None。

例子

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

let mut req = Request::builder();
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_11);

req = req.version(Version::HTTP_2);
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_2);

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

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

默认情况下，这是 HTTP/1.1。如果构建器有错误，则返回 None。

例子

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

let mut req = Request::builder();
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_11);

*req.version_mut().unwrap() = Version::HTTP_2;
assert_eq!(req.version_ref().unwrap(), &Version::HTTP_2);

pub fn header<K, V>(self, key: K, value: V) -> RequestBuilder

where HeaderName: TryFrom<K>, <HeaderName as TryFrom<K>>::Error: Into<Error>, HeaderValue: TryFrom<V>, <HeaderValue as TryFrom<V>>::Error: Into<Error>,

将标头追加到请求中。

此函数将提供的键值对追加到请求内部的 HeaderMap 中。本质上， 这相当于调用 HeaderMap::append。

例子

use boluo_core::request::Request;

let req = Request::builder()
    .header("Accept", "text/html")
    .header("X-Custom-Foo", "bar")
    .body(())
    .unwrap();

pub fn headers_ref(&self) -> Option<&HeaderMap<HeaderValue>>

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

如果构建器有错误，则返回 None。

例子

use boluo_core::request::Request;

let req = Request::builder()
    .header("Accept", "text/html")
    .header("X-Custom-Foo", "bar");

let headers = req.headers_ref().unwrap();

assert_eq!(headers["Accept"], "text/html");
assert_eq!(headers["X-Custom-Foo"], "bar");

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

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

如果构建器有错误，则返回 None。

例子

use boluo_core::http::HeaderValue;
use boluo_core::request::Request;

let mut req = Request::builder();

let headers = req.headers_mut().unwrap();
headers.insert("Accept", HeaderValue::from_static("text/html"));
headers.insert("X-Custom-Foo", HeaderValue::from_static("bar"));

let headers = req.headers_ref().unwrap();
assert_eq!(headers["Accept"], "text/html");
assert_eq!(headers["X-Custom-Foo"], "bar");

pub fn extension<T>(self, extension: T) -> RequestBuilder

where T: Clone + Send + Sync + 'static,

将一个类型添加到请求的扩展中。

例子

use boluo_core::request::Request;

let req = Request::builder()
    .extension("My Extension")
    .body(())
    .unwrap();

assert_eq!(req.extensions().get::<&'static str>(),
           Some(&"My Extension"));

pub fn extensions_ref(&self) -> Option<&Extensions>

获取请求的扩展的引用。

如果构建器有错误，则返回 None。

例子

use boluo_core::request::Request;

let req = Request::builder().extension("My Extension").extension(5u32);
let extensions = req.extensions_ref().unwrap();

assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));
assert_eq!(extensions.get::<u32>(), Some(&5u32));

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

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

如果构建器有错误，则返回 None。

例子

use boluo_core::request::Request;

let mut req = Request::builder().extension("My Extension");
let mut extensions = req.extensions_mut().unwrap();
assert_eq!(extensions.get::<&'static str>(), Some(&"My Extension"));

extensions.insert(5u32);
assert_eq!(extensions.get::<u32>(), Some(&5u32));

pub fn body<T>(self, body: T) -> Result<Request<T>>

消耗构建器，使用给定的主体构建请求。

错误

如果之前配置的任意一个参数发生错误，则在调用此函数时将返回错误。

例子

use boluo_core::request::Request;

let request = Request::builder()
    .body(())
    .unwrap();

Trait Implementations

impl Debug for RequestBuilder

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

Formats the value using the given formatter.

impl Default for RequestBuilder

fn default() -> RequestBuilder

Returns the “default value” for a type.