Struct NamespaceVersioning 

pub struct NamespaceVersioning {
    pub default_version: Option<String>,
    pub allowed_versions: HashSet<String>,
    pub pattern: String,
    pub namespace_prefix: Option<String>,
    /* private fields */
}

Available on crate feature rest and non-WebAssembly only.

Namespace versioning (URL namespace-based)

Extracts version from URL namespace patterns (e.g., /v1/, /v2/) Now fully implemented with router namespace support

Fields

default_version: Option<String>

The fallback version when no version is found in the namespace.

allowed_versions: HashSet<String>

The set of allowed API versions.

pattern: String

Pattern for extracting version from namespace (e.g., “/v{version}/”)

namespace_prefix: Option<String>

Namespace prefix (e.g., “api”)

Implementations

impl NamespaceVersioning

pub fn new() -> NamespaceVersioning

Create a new NamespaceVersioning instance

Examples

use reinhardt_rest::versioning::NamespaceVersioning;

let versioning = NamespaceVersioning::new();
assert_eq!(versioning.default_version.as_deref(), None);
assert_eq!(versioning.pattern, "/v{version}/");

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

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

Examples

use reinhardt_rest::versioning::NamespaceVersioning;

let versioning = NamespaceVersioning::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>>, ) -> NamespaceVersioning

Set the allowed versions

Examples

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

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

pub fn with_namespace_prefix(self, prefix: &str) -> NamespaceVersioning

Set the namespace prefix (e.g., “api”)

This prefix is used when constructing full namespace patterns for version detection.

Examples

use reinhardt_rest::versioning::NamespaceVersioning;

let versioning = NamespaceVersioning::new()
    .with_namespace_prefix("api");
assert_eq!(versioning.namespace_prefix, Some("api".to_string()));

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

Set a custom pattern for extracting version from namespace

This converts a pattern like “/v{version}/” into a regex pattern for matching namespaces like /v1/, /v2/, etc.

Examples

use reinhardt_rest::versioning::NamespaceVersioning;

let versioning = NamespaceVersioning::new()
    .with_pattern("/api/v{version}/");
assert_eq!(versioning.pattern, "/api/v{version}/");

Trait Implementations

impl BaseVersioning for NamespaceVersioning

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, NamespaceVersioning: '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 is_allowed_version(&self, version: &str) -> bool

Check if a version is allowed

fn version_param(&self) -> &str

Get the version parameter name

impl Clone for NamespaceVersioning

fn clone(&self) -> NamespaceVersioning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NamespaceVersioning

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

Formats the value using the given formatter.

impl Default for NamespaceVersioning

fn default() -> NamespaceVersioning

Returns the “default value” for a type.