Struct URLPathVersioning 

pub struct URLPathVersioning {
    pub default_version: Option<String>,
    pub allowed_versions: HashSet<String>,
    pub version_param: String,
    pub path_regex: Regex,
}

Available on crate feature rest and non-WebAssembly only.

URL path versioning

Example: /v1/users/ or /api/v2/users/

Fields

default_version: Option<String>

The fallback version when no version is found in the URL path.

allowed_versions: HashSet<String>

The set of allowed API versions.

version_param: String

The parameter name for version (default: "version").

path_regex: Regex

The regex pattern used to extract the version from the URL path.

Implementations

impl URLPathVersioning

pub fn new() -> URLPathVersioning

Create a new URLPathVersioning instance

Examples

use reinhardt_rest::versioning::{URLPathVersioning, BaseVersioning};

let versioning = URLPathVersioning::new();
assert_eq!(versioning.default_version.as_deref(), None);

pub fn with_default_version( self, version: impl Into<String>, ) -> URLPathVersioning

Set the default version to use when no version is found in the path

Examples

use reinhardt_rest::versioning::{URLPathVersioning, BaseVersioning};

let versioning = URLPathVersioning::new()
    .with_default_version("1.0");
assert_eq!(versioning.default_version.as_deref(), Some("1.0"));

pub fn with_allowed_versions( self, versions: Vec<impl Into<String>>, ) -> URLPathVersioning

Set the allowed versions

Examples

use reinhardt_rest::versioning::{URLPathVersioning, BaseVersioning};

let versioning = URLPathVersioning::new()
    .with_allowed_versions(vec!["1", "2", "3"]);
assert!(versioning.is_allowed_version("1"));
assert!(!versioning.is_allowed_version("99"));

pub fn with_version_param(self, param: impl Into<String>) -> URLPathVersioning

Set the version parameter name (for trait compatibility)

Examples

use reinhardt_rest::versioning::{URLPathVersioning, BaseVersioning};

let versioning = URLPathVersioning::new()
    .with_version_param("v");
assert_eq!(versioning.version_param.as_str(), "v");

pub fn with_path_regex(self, regex: Regex) -> URLPathVersioning

Set a custom regex pattern for extracting version from path

Examples

use reinhardt_rest::versioning::URLPathVersioning;
use regex::Regex;

let custom_regex = Regex::new(r"/api/v(\d+)").unwrap();
let versioning = URLPathVersioning::new()
    .with_path_regex(custom_regex);
// The versioning will now match paths like /api/v1, /api/v2, etc.

pub fn with_pattern(self, pattern: &str) -> URLPathVersioning

Set a custom pattern for extracting version from path (for configuration compatibility)

This converts a pattern like “/v{version}/” into a regex pattern.

Examples

use reinhardt_rest::versioning::URLPathVersioning;

let versioning = URLPathVersioning::new()
    .with_pattern("/v{version}/");
// The versioning will now match paths like /v1/, /v2/, etc.

Trait Implementations

impl BaseVersioning for URLPathVersioning

fn determine_version<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 Request, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, URLPathVersioning: 'async_trait,

Determine the API version from the request

fn default_version(&self) -> Option<&str>

Get the default version

fn allowed_versions(&self) -> Option<&HashSet<String>>

Get allowed versions

fn version_param(&self) -> &str

Get the version parameter name

fn is_allowed_version(&self, version: &str) -> bool

Check if a version is allowed

impl Clone for URLPathVersioning

fn clone(&self) -> URLPathVersioning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for URLPathVersioning

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

Formats the value using the given formatter.

impl Default for URLPathVersioning

fn default() -> URLPathVersioning

Returns the “default value” for a type.