Trait trillium_router::RouterConnExt

source ·
pub trait RouterConnExt {
    // Required methods
    fn param<'a>(&'a self, param: &str) -> Option<&'a str>;
    fn wildcard(&self) -> Option<&str>;
    fn route(&self) -> Option<&str>;
}
Expand description

Extends trillium::Conn with accessors for router params.

Required Methods§

source

fn param<'a>(&'a self, param: &str) -> Option<&'a str>

Retrieves a captured param from the conn. Note that this will only be Some if the exact param is present in the matched route.

Routefinder params are defined starting with a colon, but the colon is not needed when fetching the param.

use trillium::{conn_unwrap, Conn};
use trillium_router::{Router, RouterConnExt};

let router = Router::new().get("/pages/:page_name", |conn: Conn| async move {
    let page_name = conn_unwrap!(conn.param("page_name"), conn);
    let content = format!("you have reached the page named {}", page_name);
    conn.ok(content)
});

use trillium_testing::prelude::*;
assert_ok!(
    get("/pages/trillium").on(&router),
    "you have reached the page named trillium"
);
source

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

Retrieves the wildcard match from the conn. Note that this will only be Some if the matched route contains a wildcard, as expressed by a “*” in the routefinder route spec.

use trillium::{conn_unwrap, Conn};
use trillium_router::{Router, RouterConnExt};

let router = Router::new().get("/pages/*", |conn: Conn| async move {
    let wildcard = conn_unwrap!(conn.wildcard(), conn);
    let content = format!("the wildcard matched {}", wildcard);
    conn.ok(content)
});

use trillium_testing::prelude::*;
assert_ok!(
    get("/pages/this/is/a/wildcard/match").on(&router),
    "the wildcard matched this/is/a/wildcard/match"
);
source

fn route(&self) -> Option<&str>

Retrieves the matched route specification

use trillium::{conn_unwrap, Conn};
use trillium_router::{Router, RouterConnExt};

let router = Router::new().get("/pages/:page_id", |conn: Conn| async move {
    let route = conn_unwrap!(conn.route(), conn).to_string();
    conn.ok(format!("route was {route}"))
});

use trillium_testing::prelude::*;
assert_ok!(
    get("/pages/12345").on(&router),
    "route was /pages/:page_id"
);

Implementations on Foreign Types§

source§

impl RouterConnExt for Conn

source§

fn param<'a>(&'a self, param: &str) -> Option<&'a str>

source§

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

source§

fn route(&self) -> Option<&str>

Implementors§