Struct Route

pub struct Route { /* private fields */ }

A route that has been configured but has not yet been registered with a Blueprint.

Guide

Check out the “Routing” section of Pavex’s guide for a thorough introduction to routing in Pavex applications.

Use cases

Route is primarily used by kits to allow users to customize (or disable!) the bundled routes before registering them with a Blueprint.

Implementations

impl Route

pub fn new( method_guard: MethodGuard, path: &str, callable: RawIdentifiers, ) -> Self

Create a new (unregistered) route.

Check out the documentation of Blueprint::route for more details on routes.

pub fn error_handler(self, error_handler: RawIdentifiers) -> Self

Register an error handler for this route.

Check out the documentation of RegisteredRoute::error_handler for more details.

pub fn register(self, bp: &mut Blueprint) -> RegisteredRoute<'_>

Register this route with a Blueprint.

Check out the documentation of Blueprint::route for more details.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.