Struct VersionedRouteConfig 

pub struct VersionedRouteConfig {
    pub matcher: VersionRange,
    pub deprecated: bool,
    pub deprecation_message: Option<String>,
    pub sunset: Option<String>,
}

Configuration for a versioned route

Fields

matcher: VersionRange

Version matcher for this route

deprecated: bool

Whether this version is deprecated

deprecation_message: Option<String>

Deprecation message

sunset: Option<String>

Sunset date (RFC 3339)

Implementations

impl VersionedRouteConfig

pub fn version(version: ApiVersion) -> Self

Create a new route config for a specific version

pub fn range(range: VersionRange) -> Self

Create a route config for a version range

pub fn deprecated(self) -> Self

Mark this version as deprecated

pub fn with_deprecation_message(self, message: impl Into<String>) -> Self

Add a deprecation message

pub fn with_sunset(self, date: impl Into<String>) -> Self

Set a sunset date

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

Check if this config matches a version

Trait Implementations

impl Clone for VersionedRouteConfig

fn clone(&self) -> VersionedRouteConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionedRouteConfig

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

Formats the value using the given formatter.