Struct RouterRef 

pub struct RouterRef<'r>(/* private fields */);

A &mut Router for use with Router::build

A wrapper around a &mut Router that supports imperative route registration. See Router::build for further documentation.

Implementations

impl<'r> RouterRef<'r>

pub fn get<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for the get http method.

let router = Router::build(|mut router| {
    router.get("/some/route", |conn: Conn| async move {
        conn.ok("success")
    });
});

let app = TestServer::new(router).await;
app.get("/some/route").await
    .assert_ok()
    .assert_body("success");
app.get("/other/route").await
    .assert_status(404);

pub fn post<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for the post http method.

let router = Router::build(|mut router| {
    router.post("/some/route", |conn: Conn| async move {
        conn.ok("success")
    });
});

let app = TestServer::new(router).await;
app.post("/some/route").await
    .assert_ok()
    .assert_body("success");
app.post("/other/route").await
    .assert_status(404);

pub fn put<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for the put http method.

let router = Router::build(|mut router| {
    router.put("/some/route", |conn: Conn| async move {
        conn.ok("success")
    });
});

let app = TestServer::new(router).await;
app.put("/some/route").await
    .assert_ok()
    .assert_body("success");
app.put("/other/route").await
    .assert_status(404);

pub fn delete<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for the delete http method.

let router = Router::build(|mut router| {
    router.delete("/some/route", |conn: Conn| async move {
        conn.ok("success")
    });
});

let app = TestServer::new(router).await;
app.delete("/some/route").await
    .assert_ok()
    .assert_body("success");
app.delete("/other/route").await
    .assert_status(404);

pub fn patch<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for the patch http method.

let router = Router::build(|mut router| {
    router.patch("/some/route", |conn: Conn| async move {
        conn.ok("success")
    });
});

let app = TestServer::new(router).await;
app.patch("/some/route").await
    .assert_ok()
    .assert_body("success");
app.patch("/other/route").await
    .assert_status(404);

pub fn all<R>(&mut self, path: R, handler: impl Handler)

where R: TryInto<RouteSpec>, R::Error: Debug,

Appends the handler to all (get, post, put, delete, and patch) methods.

let router = Router::build(|mut router| {
    router.all("/any", |conn: Conn| async move {
        let response = format!("you made a {} request to /any", conn.method());
        conn.ok(response)
    });
});

let app = TestServer::new(router).await;
app.get("/any")
    .await
    .assert_ok()
    .assert_body("you made a GET request to /any");
app.post("/any")
    .await
    .assert_ok()
    .assert_body("you made a POST request to /any");
app.delete("/any")
    .await
    .assert_ok()
    .assert_body("you made a DELETE request to /any");
app.patch("/any")
    .await
    .assert_ok()
    .assert_body("you made a PATCH request to /any");
app.put("/any")
    .await
    .assert_ok()
    .assert_body("you made a PUT request to /any");
app.get("/").await.assert_status(404);

pub fn any<IntoMethod, R>( &mut self, methods: &[IntoMethod], path: R, handler: impl Handler, )

where R: TryInto<RouteSpec>, R::Error: Debug, IntoMethod: TryInto<Method> + Clone, <IntoMethod as TryInto<Method>>::Error: Debug,

Appends the handler to each of the provided http methods.

let router = Router::build(|mut router| {
    router.any(&["get", "post"], "/get_or_post", |conn: Conn| async move {
        let response = format!("you made a {} request to /get_or_post", conn.method());
        conn.ok(response)
    });
});

let app = TestServer::new(router).await;
app.get("/get_or_post")
    .await
    .assert_ok()
    .assert_body("you made a GET request to /get_or_post");
app.post("/get_or_post")
    .await
    .assert_ok()
    .assert_body("you made a POST request to /get_or_post");
app.delete("/any").await.assert_status(404);
app.patch("/any").await.assert_status(404);
app.put("/any").await.assert_status(404);
app.get("/").await.assert_status(404);

pub fn add_route<M, R>(&mut self, method: M, path: R, handler: impl Handler)

where M: TryInto<Method>, <M as TryInto<Method>>::Error: Debug, R: TryInto<RouteSpec>, R::Error: Debug,

Registers a handler for a method other than get, put, post, patch, or delete.

let router = Router::build(|mut router| {
    router.add_route("OPTIONS", "/some/route", |conn: Conn| async move {
        conn.ok("directly handling options")
    });

    router.add_route(Method::Checkin, "/some/route", |conn: Conn| async move {
        conn.ok("checkin??")
    });
});

let app = TestServer::new(router).await;
app.build(Method::Options, "/some/route")
    .await
    .assert_ok()
    .assert_body("directly handling options");
app.build(Method::Checkin, "/some/route")
    .await
    .assert_ok()
    .assert_body("checkin??");

pub fn set_options_handling(&mut self, options_enabled: bool)

enable or disable the router’s behavior of responding to OPTIONS requests with the supported methods at given path.

default: enabled

see crate-level docs for further explanation of the default behavior.

Trait Implementations

impl<'r> Debug for RouterRef<'r>

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

Formats the value using the given formatter.