Struct Router 

pub struct Router { /* private fields */ }

A router that can be used to route requests to their respective views.

This struct is used to route requests to their respective views. It can be created directly by calling the Router::with_urls method, and that’s what is typically done in cot::App::router implementations.

Examples

use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);

Implementations

impl Router

pub fn empty() -> Self

Create an empty router.

This router will not route any requests.

Examples

use cot::router::Router;

let router = Router::empty();

pub fn with_urls<T: Into<Vec<Route>>>(urls: T) -> Self

Create a router with the given routes.

Examples

use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);

pub async fn handle(&self, request: Request) -> Result<Response>

Handle a request.

This method is called by the CotApp to handle a request.

Errors

This method re-throws any errors that occur in the request handler.

pub fn reverse( &self, app_name: Option<&str>, name: &str, params: &ReverseParamMap, ) -> Result<String>

Get a URL for a view by name.

Instead of using this method directly, consider using the reverse! macro which provides much more ergonomic way to call this.

app_name is the name of the app that the view should be found in. If app_name is None, the view will be searched for in any app.

Errors

This method returns an error if the view name is not found.

This method returns an error if the URL cannot be generated because of missing parameters.

pub fn reverse_option( &self, app_name: Option<&str>, name: &str, params: &ReverseParamMap, ) -> Result<Option<String>>

Get a URL for a view by name.

app_name is the name of the app that the view should be found in. If app_name is None, the view will be searched for in any app.

Returns None if the view name is not found.

Errors

This method returns an error if the URL cannot be generated because of missing parameters.

pub fn routes(&self) -> &[Route]

Get the routes in this router.

Examples

use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);
assert_eq!(router.routes().len(), 1);

pub fn is_empty(&self) -> bool

Check if this router is empty.

Examples

use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::empty();
assert!(router.is_empty());

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);
assert!(!router.is_empty());

pub fn as_api(&self) -> OpenApi

Available on crate feature openapi only.

Returns the OpenAPI paths for the router.

This might be useful if you want to manually serve the generated OpenAPI specs.

Panics

Panics if invalid schemas are generated. This should not happen in normal operation, but if it does, it indicates a bug in the schemars library or in the way the OpenAPI specs are generated.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Router

fn fmt(&self, __derive_more_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.