Struct UrlRegistry 

pub struct UrlRegistry { /* private fields */ }

Registry for named routes, enabling URL generation.

Example

use fastapi_core::routing::UrlRegistry;

let mut registry = UrlRegistry::new();
registry.register("get_user", "/users/{id}");
registry.register("get_post", "/posts/{post_id:int}");

// Generate URL with path parameter
let url = registry.url_for("get_user", &[("id", "42")], &[]).unwrap();
assert_eq!(url, "/users/42");

// Generate URL with query parameters
let url = registry.url_for("get_user", &[("id", "42")], &[("fields", "name,email")]).unwrap();
assert_eq!(url, "/users/42?fields=name%2Cemail");

Implementations

impl UrlRegistry

pub fn new() -> Self

Create a new empty URL registry.

pub fn with_root_path(root_path: impl Into<String>) -> Self

Create a URL registry with a root path prefix.

The root path is prepended to all generated URLs, useful for apps running behind a reverse proxy at a sub-path.

Example

let registry = UrlRegistry::with_root_path("/api/v1");
registry.register("get_user", "/users/{id}");
let url = registry.url_for("get_user", &[("id", "42")], &[]).unwrap();
assert_eq!(url, "/api/v1/users/42");

pub fn set_root_path(&mut self, root_path: impl Into<String>)

Set the root path prefix.

pub fn root_path(&self) -> &str

Get the current root path.

pub fn register(&mut self, name: impl Into<String>, pattern: &str)

Register a named route.

Arguments

• name - The route name (used to look up the route)
• pattern - The route pattern (e.g., “/users/{id}”)

pub fn has_route(&self, name: &str) -> bool

Check if a route with the given name exists.

pub fn get_pattern(&self, name: &str) -> Option<&str>

Get the pattern for a named route.

pub fn url_for( &self, name: &str, params: &[(&str, &str)], query: &[(&str, &str)], ) -> Result<String, UrlError>

Generate a URL for a named route.

Arguments

• name - The route name
• params - Path parameters as (name, value) pairs
• query - Query parameters as (name, value) pairs

Errors

Returns an error if:

• The route name is not found
• A required path parameter is missing
• A path parameter value doesn’t match its converter type

Example

let url = registry.url_for(
    "get_user",
    &[("id", "42")],
    &[("fields", "name"), ("include", "posts")]
).unwrap();
// Returns: "/users/42?fields=name&include=posts"

pub fn len(&self) -> usize

Get the number of registered routes.

pub fn is_empty(&self) -> bool

Check if the registry is empty.

pub fn route_names(&self) -> impl Iterator<Item = &str>

Get an iterator over route names.

Trait Implementations

impl Clone for UrlRegistry

fn clone(&self) -> UrlRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UrlRegistry

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

Formats the value using the given formatter.

impl Default for UrlRegistry

fn default() -> UrlRegistry

Returns the “default value” for a type.