Struct VersionConfig 

pub struct VersionConfig {
    pub strategy: VersionStrategy,
    pub current_version: u32,
    pub supported_versions: Vec<u32>,
    pub deprecated_versions: Vec<u32>,
    pub version_header: String,
    pub deprecation_header: String,
}

Configuration for API versioning.

Fields

strategy: VersionStrategy

How to extract the version.

current_version: u32

The current (latest) version.

supported_versions: Vec<u32>

All supported versions.

deprecated_versions: Vec<u32>

Deprecated versions (still work, but emit a warning header).

version_header: String

Header name for the Header strategy.

deprecation_header: String

Header added to responses for deprecated versions.

Implementations

impl VersionConfig

pub fn new() -> Self

Create a new version config with defaults.

pub fn strategy(self, strategy: VersionStrategy) -> Self

Set the versioning strategy.

pub fn current(self, version: u32) -> Self

Set the current version.

pub fn supported(self, versions: &[u32]) -> Self

Set supported versions.

pub fn deprecated(self, versions: &[u32]) -> Self

Set deprecated versions.

pub fn version_header(self, name: impl Into<String>) -> Self

Set the version header name.

pub fn is_supported(&self, version: &ApiVersion) -> bool

Check if a version is supported.

pub fn is_deprecated(&self, version: &ApiVersion) -> bool

Check if a version is deprecated.

pub fn extract_from_path(&self, path: &str) -> Option<ApiVersion>

Extract version from a request path (URL prefix strategy).

pub fn extract_from_header(&self, value: &str) -> Option<ApiVersion>

Extract version from a header value.

pub fn deprecation_warning(&self, version: &ApiVersion) -> Option<String>

Generate deprecation warning header value for a deprecated version.

Trait Implementations

impl Clone for VersionConfig

fn clone(&self) -> VersionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionConfig

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

Formats the value using the given formatter.

impl Default for VersionConfig

fn default() -> Self

Returns the “default value” for a type.