Enum ApiVersion 

pub enum ApiVersion {
    Simple(u32),
    Semver(SemverTriple),
    Date(u16, u8, u8),
}

An API version that supports three common schemes.

Variants are ordered: Simple < Semver < Date within each variant, and by discriminant across variants (i.e. a Simple version is always less than a Semver version). Use the PartialOrd / Ord implementations for “minimum version” guards.

Variants

Simple(u32)

Integer version: v1, v2, … (stored as the bare number).

Semver(SemverTriple)

Semantic version: 1.2.3.

Date(u16, u8, u8)

Date version: YYYY-MM-DD (stored as (year, month, day)).

Implementations

impl ApiVersion

pub fn header_value(&self) -> String

Return the value suitable for use in an Accept-Version or Content-Version HTTP header (the display string).

Examples

use api_bones::version::ApiVersion;

let v = ApiVersion::Simple(2);
assert_eq!(v.header_value(), "v2");

Trait Implementations

impl Clone for ApiVersion

fn clone(&self) -> ApiVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiVersion

Available on crate feature serde and (crate features std or alloc) only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ApiVersion

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

Formats the value using the given formatter.

impl From<ApiVersion> for String

Available on crate features std or alloc only.

fn from(v: ApiVersion) -> Self

Converts to this type from the input type.

impl FromStr for ApiVersion

Available on crate features std or alloc only.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a version string.

Accepted formats:

• vN or VN — simple integer (e.g. v1)
• N.N.N — semver (e.g. 1.2.3)
• YYYY-MM-DD — date (e.g. 2024-06-01)

Errors

Returns ApiVersionParseError when s does not match any recognised format.

type Err = ApiVersionParseError

The associated error which can be returned from parsing.

impl Hash for ApiVersion

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ApiVersion

fn cmp(&self, other: &ApiVersion) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ApiVersion

fn eq(&self, other: &ApiVersion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ApiVersion

fn partial_cmp(&self, other: &ApiVersion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ApiVersion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApiVersion

impl StructuralPartialEq for ApiVersion