Struct VersioningConfig 

#[non_exhaustive]
pub struct VersioningConfig {
    pub default_version: String,
    pub allowed_versions: Vec<String>,
    pub strategy: VersioningStrategy,
    pub strict_mode: bool,
    pub version_param: Option<String>,
    pub hostname_patterns: Option<HashMap<String, String>>,
}

Global versioning configuration

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

default_version: String

Default version to use when no version is specified

allowed_versions: Vec<String>

Allowed versions (empty means any version is allowed)

strategy: VersioningStrategy

Versioning strategy configuration

strict_mode: bool

Whether to raise errors for invalid versions

version_param: Option<String>

Custom version parameter name for query parameter versioning

hostname_patterns: Option<HashMap<String, String>>

Custom hostname patterns for hostname versioning

Implementations

impl VersioningConfig

pub fn new() -> VersioningConfig

Available on native and crate feature rest only.

Create a new versioning configuration

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

Available on native and crate feature rest only.

Set the default version

pub fn with_allowed_versions(self, versions: Vec<String>) -> VersioningConfig

Available on native and crate feature rest only.

Set allowed versions

pub fn with_strategy(self, strategy: VersioningStrategy) -> VersioningConfig

Available on native and crate feature rest only.

Set versioning strategy

pub fn with_strict_mode(self, strict: bool) -> VersioningConfig

Available on native and crate feature rest only.

Enable or disable strict mode

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

Available on native and crate feature rest only.

Set custom version parameter name

pub fn with_hostname_patterns( self, patterns: HashMap<String, String>, ) -> VersioningConfig

Available on native and crate feature rest only.

Set hostname patterns

pub fn create_versioning(&self) -> Box<dyn BaseVersioning + Send + Sync>

Available on native and crate feature rest only.

Create versioning instance from configuration

Trait Implementations

impl Clone for VersioningConfig

fn clone(&self) -> VersioningConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersioningConfig

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

Formats the value using the given formatter.

impl Default for VersioningConfig

fn default() -> VersioningConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VersioningConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<VersioningConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<VersioningSettings> for VersioningConfig

fn from(settings: VersioningSettings) -> VersioningConfig

Converts to this type from the input type.

impl Serialize for VersioningConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.