Struct RiRouter 

pub struct RiRouter { /* private fields */ }

Router for managing API routes and matching requests to handlers.

This struct maintains a collection of routes organized by HTTP method using radix trees for O(k) lookup performance, where k is the path length.

Implementations

impl RiRouter

pub fn new() -> Self

Creates a new router with no routes.

Returns

A new RiRouter instance with empty routes and cache

pub fn add_route(&self, route: RiRoute)

Adds a route to the router.

This method adds a route to the router’s radix tree and clears the route cache.

Parameters

• route: The route to add to the router

impl RiRouter

pub fn get(&self, path: &str, handler: RiRouteHandler)

Adds a GET route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub fn post(&self, path: &str, handler: RiRouteHandler)

Adds a POST route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub fn put(&self, path: &str, handler: RiRouteHandler)

Adds a PUT route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub fn delete(&self, path: &str, handler: RiRouteHandler)

Adds a DELETE route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub fn patch(&self, path: &str, handler: RiRouteHandler)

Adds a PATCH route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub fn options(&self, path: &str, handler: RiRouteHandler)

Adds an OPTIONS route to the router.

Parameters

• path: Path pattern for the route
• handler: Request handler for the route

pub async fn route( &self, request: &RiGatewayRequest, ) -> RiResult<RiRouteHandler>

Finds a matching route for the given request using radix tree.

This method uses radix tree for O(k) route lookup where k is the path length. It checks the route cache first, then searches the radix tree for the matching route.

Parameters

• request: The gateway request to find a route for

Returns

A RiResult<RiRouteHandler> with the matching handler, or an error if no route is found

pub fn mount(&self, prefix: &str, router: &RiRouter)

Mounts another router’s routes with a prefix.

This method adds all routes from another router to this router, prepending the specified prefix to each route’s path.

Parameters

• prefix: The prefix to prepend to all mounted routes
• router: The router to mount

pub fn clear_routes(&self)

Clears all routes from the router.

This method removes all routes from the router, clears all radix trees, and clears the route cache.

pub fn route_count(&self) -> usize

Gets the number of routes registered in the router.

Returns

The number of routes registered in the router

Trait Implementations

impl Default for RiRouter

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiRouter

type Target = RiRouter

The Python output type

type Output = Bound<'py, <RiRouter as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiRouter

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiRouter

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Router for managing API routes and matching requests to handlers.\n\nThis struct maintains a collection of routes organized by HTTP method using\nradix trees for O(k) lookup performance, where k is the path length.\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiRouter>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiRouter

const TEXT_SIGNATURE: &'static str = "()"

impl PyMethods<RiRouter> for PyClassImplCollector<RiRouter>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiRouter

const NAME: &'static str = "RiRouter"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for RiRouter

impl ExtractPyClassWithClone for RiRouter