Struct RouteMatcher 

pub struct RouteMatcher {
    pub static_route: HashMap<String, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>, BuildHasherDefault<Hasher>>,
    pub dynamic_route: HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>,
    pub regex_route: HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>,
}

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.

Fields

static_route: HashMap<String, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>, BuildHasherDefault<Hasher>>

A hash map for storing and quickly retrieving handlers for static route. These are route without any variable path segments.

dynamic_route: HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

A layered map of dynamic routes grouped by segment count. Routes are organized by path segment count for efficient filtering during matching.

regex_route: HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

A layered map of regex routes grouped by segment count. Routes with tail regex patterns can match paths with more segments.

Implementations

impl RouteMatcher

Manages a collection of route, enabling efficient lookup and dispatch.

This struct stores route categorized by type (static, dynamic, regex) to quickly find the appropriate hook for incoming requests.

pub fn try_resolve_route<'a>( &'a self, ctx: &mut Context, path: &str, ) -> Option<&'a Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>>

Resolves a route hook by reference (no Arc::clone) for hot-path use.

Returns a reference to the matched ServerHookHandler if any. The caller must clone if it needs to retain the hook beyond the await point. Returns None if no route matched.

Arguments

• &'a self - The route table to search.
• &mut Context - The request context (for storing route params).
• &str - The request path to resolve.

Returns

• Option<&'a ServerHookHandler>: The matched handler, or None when no route matched.

impl RouteMatcher

pub fn get_static_route( &self, ) -> &HashMap<String, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>, BuildHasherDefault<Hasher>>

pub fn get_mut_static_route( &mut self, ) -> &mut HashMap<String, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>, BuildHasherDefault<Hasher>>

pub fn get_dynamic_route( &self, ) -> &HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

pub fn get_mut_dynamic_route( &mut self, ) -> &mut HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

pub fn get_regex_route( &self, ) -> &HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

pub fn get_mut_regex_route( &mut self, ) -> &mut HashMap<usize, Vec<(RoutePattern, Arc<dyn Fn(&mut Stream, &mut Context) -> Pin<Box<dyn Future<Output = Status> + Send>> + Send + Sync>)>, BuildHasherDefault<Hasher>>

Trait Implementations

impl Clone for RouteMatcher

fn clone(&self) -> RouteMatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteMatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the struct fields as a debug struct, skipping excluded fields.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.

impl Default for RouteMatcher

Provides a default implementation for RouteMatcher.

fn default() -> RouteMatcher

Creates a new, empty RouteMatcher.

Returns

• RouteMatcher - A new RouteMatcher with empty storage for static, dynamic, and regex route.

impl Display for RouteMatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the standard debug format.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.

impl Eq for RouteMatcher

Implements the Eq trait for RouteMatcher.

This indicates that RouteMatcher has a total equality relation.

impl PartialEq for RouteMatcher

Implements the PartialEq trait for RouteMatcher.

This allows for comparing two RouteMatcher instances for equality.

fn eq(&self, other: &RouteMatcher) -> bool

Checks if two RouteMatcher instances are equal.

Arguments

• &Self - The other RouteMatcher instance to compare against.

Returns

• bool - true if the instances are equal, false otherwise.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.