Struct App

pub struct App { /* private fields */ }

Your app’s starting point - where all the magic happens

Implementations

impl App

Convenience methods for App to add documented endpoints

pub fn documented_get<H, T>( self, path: &str, handler: H, doc: EndpointDoc, ) -> Self

where H: Handler<T>,

Add a documented GET endpoint

pub fn documented_post<H, T>( self, path: &str, handler: H, doc: EndpointDoc, ) -> Self

where H: Handler<T>,

Add a documented POST endpoint

impl App

pub fn new() -> Self

Start with a clean slate

pub fn with_state<T>(self, state: T) -> Self

where T: Clone + Send + Sync + 'static,

Add application state that can be accessed in handlers

pub fn middleware<M>(self, middleware: M) -> Self

where M: Middleware,

Stack up middleware for request processing

pub fn route<H, T>(self, method: Method, path: &str, handler: H) -> Self

where H: Handler<T>,

Map any HTTP method to a path with your handler

pub fn get<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle GET requests - perfect for serving pages and fetching data

pub fn post<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle POST requests - for creating new resources

pub fn put<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle PUT requests - for updating entire resources

pub fn delete<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle DELETE requests - for removing resources

pub fn patch<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle PATCH requests - for partial updates

pub fn options<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle OPTIONS requests - usually for CORS preflight

pub fn head<H, T>(self, path: &str, handler: H) -> Self

where H: Handler<T>,

Handle HEAD requests - like GET but without the body

pub fn not_found<H, T>(self, handler: H) -> Self

where H: Handler<T>,

Catch requests that don’t match any route

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

Mount another router at a specific path prefix

pub fn error_pages(self, error_pages: ErrorPages) -> Self

Configure error pages

pub fn custom_404(self, html: String) -> Self

Set a custom 404 page

pub fn custom_500(self, html: String) -> Self

Set a custom 500 page

pub fn plain_error_pages(self) -> Self

Disable default error page styling (use plain HTML)

pub fn websocket<F, Fut>(self, _path: &str, _handler: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send + 'static,

Add a WebSocket endpoint (no-op when websocket feature is disabled)

pub async fn listen( self, addr: &str, ) -> Result<(), Box<dyn Error + Send + Sync>>

Fire up the server and start handling requests

impl App

Pre-configured apps for common scenarios

pub fn with_logging() -> Self

Create a new app with logging middleware

pub fn with_cors() -> Self

Create a new app with CORS middleware

pub fn with_defaults() -> Self

Create a production-ready app with security, monitoring, and performance middleware

pub fn with_security() -> Self

Create an app with basic security features

pub fn with_monitoring() -> Self

Create an app with monitoring and metrics

Trait Implementations

impl Default for App

fn default() -> Self

Returns the “default value” for a type.