hyperlane 20.0.2

A lightweight, high-performance, and cross-platform Rust HTTP server library built on Tokio. It simplifies modern web service development by providing built-in support for middleware, WebSocket, Server-Sent Events (SSE), and raw TCP communication. With a unified and ergonomic API across Windows, Linux, and MacOS, it enables developers to build robust, scalable, and event-driven network applications with minimal overhead and maximum flexibility.
Documentation
use crate::*;

/// Represents a parsed and structured route pattern.
///
/// This struct wraps a vector of `RouteSegment`s, which are the individual components
/// of a URL path. It is used internally by the `RouteMatcher` to perform efficient
/// route matching against incoming requests.
#[derive(Clone, Debug, DisplayDebug, Getter)]
pub struct RoutePattern(
    /// The collection of segments that make up the route pattern.
    #[get]
    pub(super) RouteSegmentList,
);

/// The core routing engine responsible for matching request paths to their corresponding handlers.
///
/// The matcher categorizes route into three types for optimized performance:
/// 1.  `static_route`- For exact path matches, offering the fastest lookups.
/// 2.  `dynamic_route`- For paths with variable segments.
/// 3.  `regex_route`- For complex matching based on regular expressions.
///
/// When a request comes in, the matcher checks these categories in order to find the appropriate hook.
#[derive(Clone, CustomDebug, DisplayDebug, Getter, GetterMut, Setter)]
pub struct RouteMatcher {
    /// A hash map for storing and quickly retrieving handlers for static route.
    /// These are route without any variable path segments.
    #[get]
    #[set(skip)]
    #[get_mut(pub(super))]
    #[debug(skip)]
    pub(super) static_route: ServerHookMap,
    /// A layered map of dynamic routes grouped by segment count.
    /// Routes are organized by path segment count for efficient filtering during matching.
    #[get]
    #[set(skip)]
    #[get_mut(pub(super))]
    #[debug(skip)]
    pub(super) dynamic_route: ServerHookPatternRoute,
    /// A layered map of regex routes grouped by segment count.
    /// Routes with tail regex patterns can match paths with more segments.
    #[get]
    #[set(skip)]
    #[get_mut(pub(super))]
    #[debug(skip)]
    pub(super) regex_route: ServerHookPatternRoute,
}