Struct UrlPatternsRegistration 

pub struct UrlPatternsRegistration {
    pub get_server_router: fn() -> Arc<ServerRouter>,
    pub get_client_router: Option<fn() -> Arc<ClientRouter>>,
}

Available on non-WebAssembly only.

URL patterns registration for compile-time discovery

This type is used with the inventory crate to register URL pattern functions at compile time, allowing the framework to automatically discover and register routers without manual boilerplate in management commands like runserver or check.

Fields

• get_server_router - Function pointer to get the server router
• get_client_router - Optional function pointer to get the client router (when client-router feature is enabled)

Implementation Details

This struct is collected by inventory::collect! and can be iterated at runtime using inventory::iter::<UrlPatternsRegistration>().

The framework automatically calls these functions in execute_from_command_line() to register routers before executing management commands.

Note

You typically don’t create this struct directly. Instead, use the #[routes] attribute macro which generates the registration code automatically.

Fields

get_server_router: fn() -> Arc<ServerRouter>

Function to get the server router

This function returns an Arc<ServerRouter> with all server-side routes. The #[routes] macro extracts the server router from UnifiedRouter using into_server() and wraps it in Arc::new() automatically.

get_client_router: Option<fn() -> Arc<ClientRouter>>

Available on crate feature client-router only.

Optional function to get the client router

This function returns an Arc<ClientRouter> with all client-side routes. Set via with_client_router() builder method. The field is Option to allow feature-independent construction from macro-generated code, avoiding feature context mismatches between the library and downstream crates.

Implementations

impl UrlPatternsRegistration

pub const fn new( get_server_router: fn() -> Arc<ServerRouter>, get_client_router: Option<fn() -> Arc<ClientRouter>>, ) -> UrlPatternsRegistration

Available on crate features test and client-router only.

Create a new registration with the router factory functions

Examples

use reinhardt_urls::routers::registration::UrlPatternsRegistration;
use std::sync::Arc;

let registration = UrlPatternsRegistration::new(
    || Arc::new(routes().into_server()),
    Some(|| Arc::new(routes().into_client())),
);

Note

You typically don’t call this directly. Use the #[routes] macro instead.

pub const fn with_client_router( self, get_client_router: fn() -> Arc<ClientRouter>, ) -> UrlPatternsRegistration

Available on crate features test and client-router only.

Set the client router factory function (builder pattern)

This method is called within library code that is properly feature-gated, avoiding the feature context mismatch that would occur if the macro generated #[cfg(feature = "client-router")] code (which would be evaluated in the downstream crate’s feature context).

Note

You typically don’t call this directly. Use the #[routes] macro instead.

pub fn server_router(&self) -> Arc<ServerRouter>

Available on crate feature test only.

Get the server router from the registration

pub fn client_router(&self) -> Option<Arc<ClientRouter>>

Available on crate features test and client-router only.

Get the client router from the registration, if available

Trait Implementations

impl Clone for UrlPatternsRegistration

fn clone(&self) -> UrlPatternsRegistration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collect for UrlPatternsRegistration