Struct Route 

pub struct Route {
    pub method: Method,
    pub path: String,
    pub handler_name: String,
    pub request_validator: Option<Arc<SchemaValidator>>,
    pub response_validator: Option<Arc<SchemaValidator>>,
    pub parameter_validator: Option<ParameterValidator>,
    pub file_params: Option<Value>,
    pub is_async: bool,
    pub cors: Option<CorsConfig>,
    pub expects_json_body: bool,
    pub jsonrpc_method: Option<JsonRpcMethodInfo>,
}

Route definition with compiled validators

Validators are Arc-wrapped to enable cheap cloning across route instances and to support schema deduplication via SchemaRegistry.

The jsonrpc_method field is optional and has zero overhead when None, enabling routes to optionally expose themselves as JSON-RPC methods.

Fields

method: Method

path: String

handler_name: String

request_validator: Option<Arc<SchemaValidator>>

response_validator: Option<Arc<SchemaValidator>>

parameter_validator: Option<ParameterValidator>

file_params: Option<Value>

is_async: bool

cors: Option<CorsConfig>

expects_json_body: bool

Precomputed flag: true if this route expects a JSON request body Used by middleware to validate Content-Type headers

jsonrpc_method: Option<JsonRpcMethodInfo>

Optional JSON-RPC method information When present, this route can be exposed as a JSON-RPC method

Implementations

impl Route

pub fn from_metadata( metadata: RouteMetadata, registry: &SchemaRegistry, ) -> Result<Route, String>

Create a route from metadata, using schema registry for deduplication

Auto-generates parameter schema from type hints in the path if no explicit schema provided. Type hints like /items/{id:uuid} generate appropriate JSON Schema validation. Explicit parameter_schema overrides auto-generated schemas.

Errors

Returns an error if the schema compilation fails or metadata is invalid.

The schema registry ensures each unique schema is compiled only once, improving startup performance and memory usage for applications with many routes.

pub fn with_jsonrpc_method(self, info: JsonRpcMethodInfo) -> Route

Builder method to attach JSON-RPC method info to a route

This is a convenient way to add JSON-RPC metadata after route creation. It consumes the route and returns a new route with the metadata attached.

Examples

let route = Route::from_metadata(metadata, &registry)?
    .with_jsonrpc_method(JsonRpcMethodInfo {
        method_name: "user.create".to_string(),
        description: Some("Creates a new user".to_string()),
        params_schema: Some(request_schema),
        result_schema: Some(response_schema),
        deprecated: false,
        tags: vec!["users".to_string()],
    });

pub const fn is_jsonrpc_method(&self) -> bool

Check if this route has JSON-RPC metadata

pub fn jsonrpc_method_name(&self) -> Option<&str>

Get the JSON-RPC method name if present

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.