Struct Route 

pub struct Route {
    pub path: String,
    pub method: Method,
    pub tsr: bool,
    /* private fields */
}

HTTP route with path pattern matching and middleware support.

Fields

path: String

Original path string used to create this route.

method: Method

HTTP method this route responds to.

tsr: bool

Whether trailing slash redirection is enabled.

Implementations

impl Route

pub fn new( path: String, method: Method, handler: BoxHandler, tsr: Option<bool>, ) -> Route

Creates a new route with the specified path, method, and handler.

pub fn middleware<F, Fut, R>(&self, f: F) -> &Route

where F: Fn(Request<TakoBody>, Next) -> Fut + Clone + Send + Sync + 'static, Fut: Future<Output = R> + Send + 'static, R: Responder + Send + 'static,

Adds middleware to this route’s execution chain.

pub fn plugin<P>(&self, plugin: P) -> &Route

where P: TakoPlugin + Clone + Send + Sync + 'static,

Available on crate feature plugins only.

Adds a plugin to this route.

Route-level plugins allow applying functionality like compression, CORS, or rate limiting to specific routes instead of globally. Plugins added to a route are initialized when the route is first accessed.

Examples

use tako::{router::Router, Method, responder::Responder, types::Request};
use tako::plugins::cors::CorsBuilder;


let mut router = Router::new();
let route = router.route(Method::GET, "/api/data", handler);

// Apply CORS only to this route
let cors = CorsBuilder::new()
    .allow_origin("https://example.com")
    .build();
route.plugin(cors);

pub fn version(&self, version: Version) -> &Route

Restricts this route to a specific HTTP protocol version.

Requests whose version() does not match are answered with 505 HTTP Version Not Supported. Set once at registration; later calls are no-ops (lock-free reads in the hot path).

pub fn h09(&self) -> &Route

HTTP/0.9 guard. Shorthand for Route::version with http::Version::HTTP_09.

pub fn h10(&self) -> &Route

HTTP/1.0 guard. Shorthand for Route::version with http::Version::HTTP_10.

pub fn h11(&self) -> &Route

HTTP/1.1 guard. Shorthand for Route::version with http::Version::HTTP_11.

pub fn h2(&self) -> &Route

HTTP/2 guard. Shorthand for Route::version with http::Version::HTTP_2.

pub fn signals(&self) -> &SignalArbiter

Available on crate feature signals only.

Returns a reference to this route’s signal arbiter.

pub fn signal_arbiter(&self) -> SignalArbiter

Available on crate feature signals only.

Returns a clone of this route’s signal arbiter for shared usage.

pub fn on_signal<F, Fut>(&self, id: impl Into<String>, handler: F)

where F: Fn(Signal) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Available on crate feature signals only.

Registers a handler for a named signal on this route’s arbiter.

pub async fn emit_signal(&self, signal: Signal)

Available on crate feature signals only.

Emits a signal through this route’s arbiter.

pub fn operation_id(&self, id: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Sets a unique operation ID for this route in OpenAPI documentation.

Examples

router.route(Method::GET, "/users", list_users)
    .operation_id("listUsers");

pub fn summary(&self, summary: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Sets a short summary for this route in OpenAPI documentation.

Examples

router.route(Method::GET, "/users/{id}", get_user)
    .summary("Get user by ID");

pub fn description(&self, description: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Sets a detailed description for this route in OpenAPI documentation.

Examples

router.route(Method::GET, "/users/{id}", get_user)
    .description("Retrieves a user by their unique identifier");

pub fn tag(&self, tag: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Adds a tag to group this route in OpenAPI documentation.

Examples

router.route(Method::GET, "/users", list_users)
    .tag("users")
    .tag("public");

pub fn deprecated(&self) -> &Route

Available on crate features utoipa or vespera only.

Marks this route as deprecated in OpenAPI documentation.

Examples

router.route(Method::GET, "/v1/users", list_users_v1)
    .deprecated();

pub fn response(&self, status: u16, description: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Adds a response description for a status code in OpenAPI documentation.

Examples

router.route(Method::GET, "/users/{id}", get_user)
    .response(200, "Successful response with user data")
    .response(404, "User not found");

pub fn parameter(&self, param: OpenApiParameter) -> &Route

Available on crate features utoipa or vespera only.

Adds a parameter definition for this route in OpenAPI documentation.

Examples

use tako::openapi::{OpenApiParameter, ParameterLocation};

router.route(Method::GET, "/users", list_users)
    .parameter(OpenApiParameter {
        name: "limit".to_string(),
        location: ParameterLocation::Query,
        description: Some("Maximum number of results".to_string()),
        required: false,
    });

pub fn request_body(&self, body: OpenApiRequestBody) -> &Route

Available on crate features utoipa or vespera only.

Sets the request body description for this route in OpenAPI documentation.

Examples

use tako::openapi::OpenApiRequestBody;

router.route(Method::POST, "/users", create_user)
    .request_body(OpenApiRequestBody {
        description: Some("User data to create".to_string()),
        required: true,
        content_type: "application/json".to_string(),
    });

pub fn security(&self, requirement: impl Into<String>) -> &Route

Available on crate features utoipa or vespera only.

Adds a security requirement for this route in OpenAPI documentation.

Examples

router.route(Method::DELETE, "/users/{id}", delete_user)
    .security("bearerAuth");

pub fn openapi_metadata(&self) -> Option<RouteOpenApi>

Available on crate features utoipa or vespera only.

Returns a clone of the OpenAPI metadata for this route, if any.

pub fn timeout(&self, duration: Duration) -> &Route

Sets a timeout for this route, overriding the router-level timeout.

When a request exceeds the timeout duration, the timeout fallback handler is invoked (if configured on the router) or a 408 Request Timeout response is returned.

Examples

use std::time::Duration;

router.route(Method::POST, "/upload", upload_handler)
    .timeout(Duration::from_secs(60));

pub fn simd_json(&self, mode: SimdJsonMode) -> &Route

Configures the SIMD JSON dispatch behavior for this route.

When the simd feature is enabled, Json<T> can use the sonic_rs SIMD parser for faster deserialization. By default, SIMD is used for payloads above 2 MB. This method lets you override that threshold — or force SIMD on/off — for individual routes.

Without the simd feature this setting is accepted but has no effect.

Examples

use tako::extractors::json::SimdJsonMode;

// Always use SIMD for a heavy ingest endpoint
router.route(Method::POST, "/api/ingest", ingest)
    .simd_json(SimdJsonMode::Always);

// Use SIMD only above 4 KB
router.route(Method::POST, "/api/batch", batch)
    .simd_json(SimdJsonMode::Threshold(4096));

// Disable SIMD for a latency-sensitive tiny-payload route
router.route(Method::POST, "/api/ping", ping)
    .simd_json(SimdJsonMode::Never);