Struct summer_boot::Route

pub struct Route<'a, State> { /* private fields */ }

A handle to route

所有HTTP请求都是针对资源请求的。 使用Server::at 或者 Route::at 创建路由，可以使用 Route 类型 为路径的一些HTTP方法创建endpoints

Implementations

impl<'a, State: Clone + Send + Sync + 'static> Route<'a, State>

pub fn at<'b>(&'b mut self, path: &str) -> Route<'b, State>

使用指定 path 添加路由。

pub fn path(&self) -> &str

获取当前路径

pub fn with<M>(&mut self, middleware: M) -> &mut Self

where M: Middleware<State>,

将给定中间件作为当前路由。

pub fn reset_middleware(&mut self) -> &mut Self

重置当前路由的中间件

pub fn nest<InnerState>(&mut self, service: Server<InnerState>) -> &mut Self

where State: Clone + Send + Sync + 'static, InnerState: Clone + Send + Sync + 'static,

在当前路径上嵌套 Server。

Note

其他服务 始终 具有优先权 重叠路径，这个例子输入 /hello 将 返回 “Unexpected” 给客户端

#[async_std::main]
async fn main() -> Result<(), std::io::Error> {
    let mut app = summer_boot::new();
    app.at("/hello").nest({
        let mut example = summer_boot::with_state("world");
        example
            .at("/")
            .get(|req: summer_boot::Request<&'static str>| async move {
                Ok(format!("Hello {state}!", state = req.state()))
            });
        example
    });
    app.at("/*").get(|_| async { Ok("Unexpected") });
    app.listen("127.0.0.1:8080").await?;
    Ok(())
}

pub fn serve_dir(&mut self, dir: impl AsRef<Path>) -> Result<()>

静态目录服务。

每一个文件都将从磁盘io流传输，并确定了mime类型

Security

这个方法确保了除了指定文件夹下之外的文件的路径 无论是否存在都会返回StatusCode::Forbidden

Examples

本地服务提供目录 ./public/images/* 来自路径 localhost:8080/images/*.

#[async_std::main]
async fn main() -> Result<(), std::io::Error> {
    let mut app = summer_boot::new();
    // app.at("/images/*").serve_dir("public/images/")?;
    app.listen("127.0.0.1:8080").await.unwrap();
    Ok(())
}

pub fn serve_file(&mut self, file: impl AsRef<Path>) -> Result<()>

提供静态文件。

每一个文件都将从磁盘io流传输，并确定了mime类型 基于magic bytes。类似serve_dir

pub fn method(&mut self, method: Method, ep: impl Endpoint<State>) -> &mut Self

给定HTTP方法添加endpoint

pub fn all(&mut self, ep: impl Endpoint<State>) -> &mut Self

为所有HTTP方法添加一个endpoin，作为回调。

尝试使用特定HTTP方法的路由。

pub fn get(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 GET 请求添加endpoint

pub fn head(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 HEAD 请求添加endpoint

pub fn put(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 PUT 请求添加endpoint

pub fn post(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 POST 请求添加endpoint

pub fn delete(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 `DELETE 请求添加endpoint

pub fn options(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 OPTIONS 请求添加endpoint

pub fn connect(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 CONNECT 请求添加endpoint

pub fn patch(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 PATCH 请求添加endpoint

pub fn trace(&mut self, ep: impl Endpoint<State>) -> &mut Self

为 TRACE 请求添加endpoint