Struct Builder

pub struct Builder { /* private fields */ }

HTTP请求的构建器。

Implementations

impl Builder

pub fn new() -> Builder

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

例子

use puzz_http::request::Builder;

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

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

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

设置请求的HTTP方法。

默认情况下，这是GET。

例子

use puzz_http::Request;

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

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

获取请求的HTTP方法。

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

例子

use puzz_http::{Method, 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 uri<T>(self, uri: T) -> Builder

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

设置请求的URI。

默认情况下，这是/。

例子

use puzz_http::Request;

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

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

获取请求的URI。

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

例子

use puzz_http::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 version(self, version: Version) -> Builder

设置请求的HTTP版本。

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

例子

use puzz_http::{Request, Version};

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

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

获取请求的HTTP版本。

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

例子

use puzz_http::{Request, Version};

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 header<K, V>(self, key: K, value: V) -> Builder

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 puzz_http::Request;

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

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

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

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

例子

use puzz_http::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>

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

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

例子

use puzz_http::{HeaderValue, 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) -> Builder

where T: 'static,

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

例子

use puzz_http::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 puzz_http::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 puzz_http::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>, Error>

消耗构建器，使用给定的正文构建请求。

错误

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

例子

use puzz_http::Request;

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

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.