Struct ClientPathPattern 

pub struct ClientPathPattern { /* private fields */ }

Available on crate feature client-router only.

Represents a compiled path pattern.

Supports Django-style patterns like:

• /users/ - Exact match
• /users/{id}/ - Single path parameter
• /users/{id}/posts/{post_id}/ - Multiple parameters
• /static/{path:*} - Wildcard matching (rest of path)

Wildcard Behavior

The {name:*} wildcard syntax compiles to (.*), which matches any character including path separators (/). This means a pattern like /files/{path:*} will match /files/a/b/c/d, capturing a/b/c/d as a single parameter value.

Security warning: If the captured wildcard value is used for file system access, callers must validate the value to prevent path traversal attacks (e.g., reject .. segments, absolute paths, and encoded sequences like %2e or %2f).

Implementations

impl ClientPathPattern

pub fn new(pattern: &str) -> Result<ClientPathPattern, String>

Available on crate feature test and non-WebAssembly only.

Creates a new path pattern from a Django-style pattern string.

Returns an error if the pattern is too long, has too many segments, or contains an invalid regex.

Pattern Syntax

• {name} - Captures a path segment (excludes /)
• {name:*} - Captures the rest of the path (includes /)
• Literal text is matched exactly

Errors

Returns String error if:

• Pattern exceeds maximum length (1024 bytes)
• Pattern has too many path segments (>32)
• Pattern compiles to an invalid regex

pub fn pattern(&self) -> &str

Available on crate feature test and non-WebAssembly only.

Returns the original pattern string.

pub fn param_names(&self) -> &[String]

Available on crate feature test and non-WebAssembly only.

Returns the parameter names.

pub fn matches( &self, path: &str, ) -> Option<(HashMap<String, String>, Vec<String>)>

Available on crate feature test and non-WebAssembly only.

Attempts to match a path against this pattern.

Returns Some((params, param_values)) if the path matches, where:

• params is a map of parameter names to their extracted values
• param_values is a vector of values in the order they appear in the pattern

pub fn reverse(&self, params: &HashMap<String, String>) -> Option<String>

Available on crate feature test and non-WebAssembly only.

Generates a path from this pattern with the given parameters.

pub fn is_match(&self, path: &str) -> bool

Available on crate feature test and non-WebAssembly only.

Checks if this pattern would match the given path.

pub fn is_exact(&self) -> bool

Available on crate feature test and non-WebAssembly only.

Returns whether this is an exact match pattern (no parameters).

Trait Implementations

impl Clone for ClientPathPattern

fn clone(&self) -> ClientPathPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientPathPattern

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

Formats the value using the given formatter.

impl Display for ClientPathPattern

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

Formats the value using the given formatter.

impl PartialEq for ClientPathPattern

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ClientPathPattern