Struct AppRoutes

pub struct AppRoutes { /* private fields */ }

Represents the routes of the application.

Implementations

impl AppRoutes

pub fn with_default_routes() -> Self

Create a new instance with the default routes.

pub fn empty() -> Self

Create an empty instance.

pub fn collect(&self) -> Vec<ListRoutes>

pub fn get_prefix(&self) -> Option<&String>

Get the prefix of the routes.

pub fn get_routes(&self) -> &[Routes]

Get the routes.

pub fn prefix(self, prefix: &str) -> Self

Set a prefix for the routes. this prefix will be a prefix for all the routes.

Example

In the following example you are adding api as a prefix for all routes

use loco_rs::controller::AppRoutes;

AppRoutes::with_default_routes().prefix("api");

pub fn add_route(self, route: Routes) -> Self

Add a single route.

pub fn add_routes(self, mounts: Vec<Routes>) -> Self

Add multiple routes.

pub fn to_router(&self, ctx: AppContext) -> Result<AXRouter>

Convert the routes to an Axum Router, and set a list of middlewares that configure in the config::Config

Errors

Return an Result when could not convert the router setup to axum::Router.

Trait Implementations

impl Clone for AppRoutes

fn clone(&self) -> AppRoutes

Returns a duplicate of the value.

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

Performs copy-assignment from source.