zyn.Route#

/// A route action or mounted route table declaration.
pub const Route = struct {
    method: []const u8,
    path: []const u8,
    action: RouteAction,
    defaults: RouteDefaults,
    mounted_table: ?RouteTable = null,

    /// Declares a GET route.
    pub fn get(path: []const u8, action: RouteAction, defaults: RouteDefaults) Route;

    /// Declares a POST route.
    pub fn post(path: []const u8, action: RouteAction, defaults: RouteDefaults) Route;

    /// Declares a PUT route.
    pub fn put(path: []const u8, action: RouteAction, defaults: RouteDefaults) Route;

    /// Declares a PATCH route.
    pub fn patch(path: []const u8, action: RouteAction, defaults: RouteDefaults) Route;

    /// Declares a DELETE route.
    pub fn delete(path: []const u8, action: RouteAction, defaults: RouteDefaults) Route;

    /// Declares a route for any standard or custom method string.
    pub fn match(
        method: []const u8,
        path: []const u8,
        action: RouteAction,
        defaults: RouteDefaults,
    ) Route;

    /// Mounts a route table below a path prefix.
    pub fn mount(path: []const u8, table: RouteTable, defaults: RouteDefaults) Route;
};