Struct trillium_router::Router

pub struct Router { /* private fields */ }

The Router handler

See crate level docs for more, as this is the primary type in this crate.

Implementations

impl Router

pub fn new() -> Self

Constructs a new Router. This is often used with Router::get, Router::post, Router::put, Router::delete, and Router::patch chainable methods to build up an application.

For an alternative way of constructing a Router, see Router::build

let router = Router::new()
    .get("/", |conn: Conn| async move { conn.ok("you have reached the index") })
    .get("/some/:param", |conn: Conn| async move { conn.ok("you have reached /some/:param") })
    .post("/", |conn: Conn| async move { conn.ok("post!") });

use trillium_testing::prelude::*;
assert_ok!(get("/").on(&router), "you have reached the index");
assert_ok!(get("/some/route").on(&router), "you have reached /some/:param");
assert_ok!(post("/").on(&router), "post!");

pub fn without_options_handling(self) -> Self

Disable the default behavior of responding to OPTIONS requests with the supported methods at a given path

pub fn build(builder: impl Fn(RouterRef<'_>)) -> Router

Another way to build a router, if you don’t like the chainable interface described in Router::new. Note that the argument to the closure is a RouterRef.

let router = Router::build(|mut router| {
    router.get("/", |conn: Conn| async move {
        conn.ok("you have reached the index")
    });

    router.get("/some/:paramroute", |conn: Conn| async move {
        conn.ok("you have reached /some/:param")
    });

    router.post("/", |conn: Conn| async move {
        conn.ok("post!")
    });
});


use trillium_testing::prelude::*;
assert_ok!(get("/").on(&router), "you have reached the index");
assert_ok!(get("/some/route").on(&router), "you have reached /some/:param");
assert_ok!(post("/").on(&router), "post!");

pub fn with_route<M, R>(self, method: M, path: R, handler: impl Handler) -> Self

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::new()
    .with_route("OPTIONS", "/some/route", |conn: Conn| async move { conn.ok("directly handling options") })
    .with_route(Method::Checkin, "/some/route", |conn: Conn| async move { conn.ok("checkin??") });

use trillium_testing::{prelude::*, TestConn};
assert_ok!(TestConn::build(Method::Options, "/some/route", ()).on(&router), "directly handling options");
assert_ok!(TestConn::build("checkin", "/some/route", ()).on(&router), "checkin??");

pub fn all<R>(self, path: R, handler: impl Handler) -> Self

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

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

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

use trillium_testing::prelude::*;
assert_ok!(get("/any").on(&router), "you made a GET request to /any");
assert_ok!(post("/any").on(&router), "you made a POST request to /any");
assert_ok!(delete("/any").on(&router), "you made a DELETE request to /any");
assert_ok!(patch("/any").on(&router), "you made a PATCH request to /any");
assert_ok!(put("/any").on(&router), "you made a PUT request to /any");

assert_not_handled!(get("/").on(&router));

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

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

Appends the handler to each of the provided http methods.

let router = Router::new().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)
});

use trillium_testing::prelude::*;
assert_ok!(get("/get_or_post").on(&router), "you made a GET request to /get_or_post");
assert_ok!(post("/get_or_post").on(&router), "you made a POST request to /get_or_post");
assert_not_handled!(delete("/any").on(&router));
assert_not_handled!(patch("/any").on(&router));
assert_not_handled!(put("/any").on(&router));
assert_not_handled!(get("/").on(&router));

pub fn get<R>(self, path: R, handler: impl Handler) -> Self

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

Registers a handler for the get http method.

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

use trillium_testing::{methods::get, assert_ok, assert_not_handled};
assert_ok!(get("/some/route").on(&router), "success");
assert_not_handled!(get("/other/route").on(&router));

pub fn post<R>(self, path: R, handler: impl Handler) -> Self

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

Registers a handler for the post http method.

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

use trillium_testing::{methods::post, assert_ok, assert_not_handled};
assert_ok!(post("/some/route").on(&router), "success");
assert_not_handled!(post("/other/route").on(&router));

pub fn put<R>(self, path: R, handler: impl Handler) -> Self

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

Registers a handler for the put http method.

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

use trillium_testing::{methods::put, assert_ok, assert_not_handled};
assert_ok!(put("/some/route").on(&router), "success");
assert_not_handled!(put("/other/route").on(&router));

pub fn delete<R>(self, path: R, handler: impl Handler) -> Self

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

Registers a handler for the delete http method.

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

use trillium_testing::{methods::delete, assert_ok, assert_not_handled};
assert_ok!(delete("/some/route").on(&router), "success");
assert_not_handled!(delete("/other/route").on(&router));

pub fn patch<R>(self, path: R, handler: impl Handler) -> Self

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

Registers a handler for the patch http method.

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

use trillium_testing::{methods::patch, assert_ok, assert_not_handled};
assert_ok!(patch("/some/route").on(&router), "success");
assert_not_handled!(patch("/other/route").on(&router));

Trait Implementations

impl Debug for Router

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

Formats the value using the given formatter.

impl Default for Router

fn default() -> Self

Returns the “default value” for a type.

impl Handler for Router

fn run<'life0, 'async_trait>( &'life0 self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement Handler::upgrade. The first handler that responds true to this will receive ownership of the trillium::Upgrade in a subsequent call to Handler::upgrade

fn upgrade<'life0, 'async_trait>( &'life0 self, upgrade: Upgrade, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This will only be called if the handler reponds true to Handler::has_upgrade and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, info: &'life1 mut Info, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.