Struct summer_boot::utils::request::Request

source ·

pub struct Request<State> { /* private fields */ }

Expand description

HTTP request.

请求、路由参数以及访问请求的各种方式。中间件和endpoints之间的通信

Implementations§

source §

impl<State> Request<State>

source

pub fn method(&self) -> Method

访问请求的HTTP方法。

Examples

use summer_boot::Request;

let mut app = summer_boot::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.method(), http_types::Method::Get);
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

source

pub fn url(&self) -> &Url

访问请求的完整URI方法。

source

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

访问请求的HTTP版本。

Examples

use summer_boot::Request;

let mut app = summer_boot::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.version(), Some(http_types::Version::Http1_1));
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

source

pub fn peer_addr(&self) -> Option<&str>

获取基础传输的socket地址

source

pub fn local_addr(&self) -> Option<&str>

获取基础传输的本地地址

source

pub fn remote(&self) -> Option<&str>

获取此请求的远程地址。

按以下优先级确定：

Forwarded head for key
第一个 X-Forwarded-For header
传输的对等地址

source

pub fn host(&self) -> Option<&str>

获取此请求的目标主机。

按以下优先级确定：

Forwarded header host key
第一个 X-Forwarded-Host header
Host header
URL域

source

pub fn content_type(&self) -> Option<Mime>

以“Mime”形式获取请求内容类型。

这将获取请求 Content-Type header。

获取HTTP header.

Examples

use summer_boot::Request;

let mut app = summer_boot::new();
app.at("/").get(|req: Request<()>| async move {
    assert_eq!(req.header("X-Forwarded-For").unwrap(), "127.0.0.1");
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

source

pub fn header_mut( &mut self, name: impl Into<HeaderName> ) -> Option<&mut HeaderValues>

获取标题的可变引用。

source

pub fn insert_header( &mut self, name: impl Into<HeaderName>, values: impl ToHeaderValues ) -> Option<HeaderValues>

设置一个 HTTP header.

source

pub fn append_header( &mut self, name: impl Into<HeaderName>, values: impl ToHeaderValues )

将header添加到headers。

与 insert 不同，此函数不会重写标头的内容，而是插入如果没有header。添加到现有的headers列表中。

source

pub fn remove_header( &mut self, name: impl Into<HeaderName> ) -> Option<HeaderValues>

移除一个 header.

source

pub fn iter(&self) -> Iter<'_>

以任意顺序访问所有header的迭代。

source

pub fn iter_mut(&mut self) -> IterMut<'_>

迭代器以任意顺序访问所有header，并对值进行可变引用。

source

pub fn header_names(&self) -> Names<'_>

以任意顺序访问所有header名称的迭代。

source

pub fn header_values(&self) -> Values<'_>

以任意顺序访问所有header值的迭代。

source

pub fn ext<T: Send + Sync + 'static>(&self) -> Option<&T>

获取请求扩展值。

source

pub fn ext_mut<T: Send + Sync + 'static>(&mut self) -> Option<&mut T>

获取对存储在请求扩展中的值的可变引用。

source

pub fn set_ext<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T>

设置请求扩展值。

source

pub fn state(&self) -> &State

访问应用程序范围的状态。

source

pub fn param(&self, key: &str) -> Result<&str>

按名称提取和解析路由参数。

以 &str 形式返回参数，该参数是从此 Request 借用的。

名称应不包括引用 :。

Errors

如果 key 不是路由的有效参数，则返回错误。

Examples

use summer_boot::{Request, Result};

async fn greet(req: Request<()>) -> Result<String> {
    let name = req.param("name").unwrap_or("world");
    Ok(format!("Hello, {}!", name))
}

let mut app = summer_boot::new();
app.at("/hello").get(greet);
app.at("/hello/:name").get(greet);
app.listen("127.0.0.1:8080").await?;

source

pub fn wildcard(&self) -> Option<&str>

从路由中提取通配符（如果存在）

以 &str 形式返回参数，该参数是从此 Request 借用的。

Examples

use summer_boot::{Request, Result};

async fn greet(req: Request<()>) -> Result<String> {
    let name = req.wildcard().unwrap_or("world");
    Ok(format!("Hello, {}!", name))
}

let mut app = summer_boot::new();
app.at("/hello/*").get(greet);
app.listen("127.0.0.1:8080").await?;

source

pub fn query<'de, T: Deserialize<'de>>(&'de self) -> Result<T>

使用serde_qs将URL查询组件解析为结构将整个查询作为未解析的字符串获取，使用 request.url().query()。

Examples

use std::collections::HashMap;
use summer_boot::http_types::{self, convert::Deserialize};
use summer_boot::Request;

// 所有权结构:

#[derive(Deserialize)]
struct Index {
    page: u32,
    selections: HashMap<String, String>,
}

let req: Request<()> = http_types::Request::get("https://baidu.com/get?page=2&selections[width]=narrow&selections[height]=tall").into();
let Index { page, selections } = req.query().unwrap();
assert_eq!(page, 2);
assert_eq!(selections["width"], "narrow");
assert_eq!(selections["height"], "tall");

// 使用借用s:

#[derive(Deserialize)]
struct Query<'q> {
    format: &'q str,
}

let req: Request<()> = http_types::Request::get("https://httpbin.org/get?format=bananna").into();
let Query { format } = req.query().unwrap();
assert_eq!(format, "bananna");

source

pub fn set_body(&mut self, body: impl Into<Body>)

设置body读取

source

pub fn take_body(&mut self) -> Body

处理请求 Body

可以在获取或读取body后调用此方法，但是将返回一个空的Body.

这对于通过AsyncReader或AsyncBufReader有用。

source

pub async fn body_bytes(&mut self) -> Result<Vec<u8>>

将整个请求body读取字节缓冲区。

可以在读取body后调用此方法，但生成空缓冲区。

Errors

读取body时遇到的任何I/O错误都会立即返回错误 Err

Examples

use summer_boot::Request;

let mut app = summer_boot::new();
app.at("/").get(|mut req: Request<()>| async move {
    let _body: Vec<u8> = req.body_bytes().await.unwrap();
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

source

pub async fn body_string(&mut self) -> Result<String>

将整个请求body读取字符串。

可以在读取body后调用此方法，但生成空缓冲区。

Errors

读取body时遇到的任何I/O错误都会立即返回错误 Err

如果body不能解释有效的UTF-8，则返回 Err

Examples

use summer_boot::Request;

let mut app = summer_boot::new();
app.at("/").get(|mut req: Request<()>| async move {
    let _body: String = req.body_string().await.unwrap();
    Ok("")
});
app.listen("127.0.0.1:8080").await?;

source

pub async fn body_json<T: DeserializeOwned>(&mut self) -> Result<T>

通过json读取并反序列化整个请求body。

Errors

读取body时遇到的任何I/O错误都会立即返回错误 Err

如果无法将body解释为目标类型 T 的有效json，则返回 Err

source

pub async fn body_form<T: DeserializeOwned>(&mut self) -> Result<T>

将请求主体解析为表单

use serde::Deserialize;
let mut app = summer_boot::new();

#[derive(Deserialize)]
struct Animal {
  name: String,
  legs: u8
}

app.at("/").post(|mut req: summer_boot::Request<()>| async move {
    let animal: Animal = req.body_form().await?;
    Ok(format!(
        "hello, {}! i've put in an order for {} shoes",
        animal.name, animal.legs
    ))
});

app.listen("localhost:8000").await?;

// $ curl localhost:8000/test/api -d "name=chashu&legs=4"
// hello, chashu! i've put in an order for 4 shoes

// $ curl localhost:8000/test/api -d "name=mary%20millipede&legs=750"
// number too large to fit in target type