route

Route Definition DSL

Provides a type-safe DSL for defining HTTP routes. Routes are parsed by the compiler to generate optimized dispatch code with pattern matching.

Types

Route

</>

Represents a route definition in the routing DSL. Can be a single route with method and path, a group of routes with shared prefix, or a redirect rule.

pub type Route {
  Route(method: http.Method, path: String, middleware: List(Nil))
  Group(
    routes: List(Route),
    path_prefix: String,
    middleware: List(Nil),
  )
  Redirect(from: String, to: String, status: Int)
}

Constructors

Route(method: http.Method, path: String, middleware: List(Nil))

Group(
  routes: List(Route),
  path_prefix: String,
  middleware: List(Nil),
)

Redirect(from: String, to: String, status: Int)

Values

delete

</>

pub fn delete(path: String, handler: a) -> Route

Creates a DELETE route for the given path. Used for removing resources from the server, typically returning empty response or confirmation on success.

get

</>

pub fn get(path: String, handler: a) -> Route

Creates a GET route for the given path. The handler function is captured by the compiler for code generation but not stored in the route struct at runtime.

group_middleware

</>

pub fn group_middleware(
  middleware_list: List(a),
  routes: List(Route),
) -> Route

Groups routes with shared middleware. The middleware list is extracted by the compiler and applied to all routes within the group during request processing.

head

</>

pub fn head(path: String, handler: a) -> Route

Creates a HEAD route for the given path. Returns headers identical to GET but without response body, useful for checking resource existence or metadata.

middleware

</>

pub fn middleware(
  route: Route,
  middleware_list: List(a),
) -> Route

Attaches middleware to a route. The middleware list is extracted by the compiler from source text and applied during request processing. Returns route unchanged.

options

</>

pub fn options(path: String, handler: a) -> Route

Creates an OPTIONS route for the given path. Used for CORS preflight requests and discovering allowed methods on a resource endpoint.

patch

</>

pub fn patch(path: String, handler: a) -> Route

Creates a PATCH route for the given path. Used for partial resource updates where only changed fields are sent rather than the complete resource.

post

</>

pub fn post(path: String, handler: a) -> Route

Creates a POST route for the given path. Used for form submissions, API endpoints that create resources, and other data-sending operations.

prefix

</>

pub fn prefix(path_prefix: String, routes: List(Route)) -> Route

Groups routes under a common path prefix. All routes in the group will have the prefix prepended to their paths during compilation.

put

</>

pub fn put(path: String, handler: a) -> Route

Creates a PUT route for the given path. Used for full resource updates where the client sends the complete replacement representation.

redirect

</>

pub fn redirect(from: String, to: String) -> Route

Creates a temporary redirect from one path to another. Returns HTTP 303 status code indicating the resource has temporarily moved to the target location.

redirect_permanent

</>

pub fn redirect_permanent(from: String, to: String) -> Route

Creates a permanent redirect from one path to another. Returns HTTP 308 status code indicating the resource has permanently moved to the target location.