Struct router_rs::prelude::Route

pub struct Route { /* fields omitted */ }

A route specifies a path to match against. When a match is found a view_creator is used to return an impl View that can be used to render the appropriate content for that route.

Methods

impl Route

pub fn new(
    route_definition: &'static str,
    route_param_parser: ParseRouteParam
) -> Route

Create a new Route. You'll usually later call route.match(...) in order to see if a given the path in the browser URL matches your route's path definition.

impl Route

pub fn matches(&self, path: &str) -> bool

Determine whether or not our route matches a provided path.

Example

// path = "/food/:food_type"

route.matches("/food/tacos");

pub fn view(&self, incoming_path: &str) -> VirtualNode

Given an incoming path, create the View that uses that path data.

For example.. if our defined path is /users/:id and our incoming path is /users/5

Our view will end up getting created with id: 5

pub fn find_route_param<'a>(
    &self,
    incoming_path: &'a str,
    param_key: &str
) -> Option<&'a str>

Given an incoming path and a param_key, get the RouteParam

Trait Implementations

impl Debug for Route

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

Formats the value using the given formatter.