Enum VersionStrategy 

pub enum VersionStrategy {
    Path {
        pattern: String,
    },
    Header {
        name: String,
    },
    Query {
        param: String,
    },
    Accept {
        pattern: String,
    },
    Custom {
        name: String,
    },
}

Strategy for extracting API version from requests

Variants

Path

Extract version from URL path (e.g., /v1/users)

The pattern should include {version} placeholder Example: “/v{version}/” or “/{version}/”

Fields

pattern: String

Pattern for matching version in path

Header

Extract version from HTTP header

Example: X-API-Version: 1.0

Fields

name: String

Header name to read version from

Query

Extract version from query parameter

Example: ?version=1.0 or ?api-version=1.0

Fields

param: String

Query parameter name

Accept

Extract version from Accept header media type

Example: Accept: application/vnd.api.v1+json

Fields

pattern: String

Media type pattern with version placeholder Example: “application/vnd.{vendor}.v{version}+json”

Custom

Use a custom extractor function

Uses a named custom extractor registered with the router

Fields

name: String

Name of the custom extractor

Implementations

impl VersionStrategy

pub fn path() -> Self

Create a path-based versioning strategy

Default pattern: “/v{version}/”

pub fn path_with_pattern(pattern: impl Into<String>) -> Self

Create a path strategy with custom pattern

pub fn header() -> Self

Create a header-based versioning strategy

Default header: “X-API-Version”

pub fn header_with_name(name: impl Into<String>) -> Self

Create a header strategy with custom header name

pub fn query() -> Self

Create a query parameter versioning strategy

Default parameter: “version”

pub fn query_with_param(param: impl Into<String>) -> Self

Create a query strategy with custom parameter name

pub fn accept() -> Self

Create an Accept header versioning strategy

Default pattern: “application/vnd.api.v{version}+json”

pub fn accept_with_pattern(pattern: impl Into<String>) -> Self

Create an Accept strategy with custom pattern

pub fn custom(name: impl Into<String>) -> Self

Create a custom extraction strategy

Trait Implementations

impl Clone for VersionStrategy

fn clone(&self) -> VersionStrategy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionStrategy

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

Formats the value using the given formatter.

impl Default for VersionStrategy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VersionStrategy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for VersionStrategy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.