Struct gotham::router::Router

pub struct Router { /* fields omitted */ }

Responsible for dispatching HTTP requests to defined routes, and responding with appropriate error codes when a valid Route is unable to be determined or the dispatch cannot be performed.

A Router is constructed through the gotham::router::builder API, and used with the gotham::start function when booting a Gotham web application.

The Router is capable of delegating requests to secondary Router instances, which allows the support of "modular applications". A modular application contains multiple applications within a single binary that have clear boundaries established via Rust module separation. Please see the documentation for DrawRoutes::delegate within gotham::router::builder in order to delegate to other Router instances.

Methods

impl Router

pub fn new(tree: Tree, response_finalizer: ResponseFinalizer) -> Router

Deprecated since 0.2.0

: use the new gotham::router::builder API to construct a Router

Manually assembles a Router instance from a provided Tree.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl NewHandler for Router

type Instance = Router

The type of Handler created by the NewHandler.

fn new_handler(&self) -> Result<Self::Instance>

Create and return a new Handler value.

impl Handler for Router

Important traits for Box<W>

impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn handle(self, state: State) -> Box<HandlerFuture>

Handles the Request by determining the correct Route from the internal Tree, storing any path related variables in State and dispatching to the associated Handler.