Struct RouterBuilder 

pub struct RouterBuilder<S = ()> { /* private fields */ }

路由构建器

对 axum::Router 的薄封装，提供链式 API 和未来扩展点（如 PHP 风格的 Route::group() / Route::resource()）。

用法

use sz_rust_core::router::RouterBuilder;
use axum::Json;

let router = RouterBuilder::new()
    .get("/ping", || async { "pong" })
    .post("/echo", |Json(v): Json<serde_json::Value>| async move { Json(v) })
    .build();

路由构建器（泛型状态支持）

S 为应用共享状态类型，由首次注册的路由 handler 推断。 当 handler 使用 axum::extract::State<S> 时，S 自动确定为该状态类型。

用法

// 无状态路由
let router = RouterBuilder::new()
    .get("/ping", ping_handler)
    .build();

// 有状态路由（S 由 handler 推断为 AppState）
let router = RouterBuilder::new()
    .get("/items", list_items)  // list_items 使用 State<AppState>
    .with_state(AppState::default())
    .build();

Implementations

impl<S> RouterBuilder<S>

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

pub fn new() -> Self

创建空的 RouterBuilder

pub fn with_router(inner: Router<S>) -> Self

从已有 Router 起步

pub fn with_state<S2>(self, state: S) -> RouterBuilder<S2>

注入应用状态并转换状态类型

当注册的 handler 使用了 axum::extract::State<S> 时调用， 将 RouterBuilder<S> 转换为 RouterBuilder<S2>（通常 S2 = S）。

用法

let builder = RouterBuilder::new()
    .get("/items", list_items)
    .with_state(AppState { db: pool });

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

where H: Handler<T, S>, T: 'static,

注册 GET 路由

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

where H: Handler<T, S>, T: 'static,

注册 POST 路由

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

where H: Handler<T, S>, T: 'static,

注册 PUT 路由

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

where H: Handler<T, S>, T: 'static,

注册 DELETE 路由

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

注册 WebSocket 路由（原生框架集成，无需独立端口）

在主 HTTP 端口上处理 WebSocket 升级请求（如 GET /ws/chat）。 对齐 PHP Workerman websocket:// 协议，但复用 HTTP 端口。

用法

use sz_rust_core::router::RouterBuilder;
use sz_rust_core::websocket_route::EchoWsHandler;

let router = RouterBuilder::new()
    .ws("/ws/echo", EchoWsHandler::new())
    .build();

pub fn layer<L>(self, layer: L) -> Self

where L: Layer<Route> + Clone + Send + Sync + 'static, L::Service: Service<Request> + Clone + Send + Sync + 'static, <L::Service as Service<Request>>::Response: IntoResponse + 'static, <L::Service as Service<Request>>::Error: Into<Infallible> + 'static, <L::Service as Service<Request>>::Future: Send + 'static,

应用一个 tower::Layer

约束与 axum::Router::layer 一致，便于直接链式调用任何 tower-http 中间件。

pub fn merge(self, other: Router<S>) -> Self

合并另一个 Router

pub fn build(self) -> Router<S>

构建最终的 axum::Router

Trait Implementations

impl Default for RouterBuilder

fn default() -> Self

Returns the “default value” for a type.