containers_api/
version.rs

1use std::str::FromStr;
2use thiserror::Error as ThisError;
3
4#[derive(Debug, ThisError)]
5pub enum Error {
6    #[error("Invalid version - {0}")]
7    MalformedVersion(String),
8}
9
10#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
11/// Structure representing API version used to determine compatibility between a client and a server.
12pub struct ApiVersion {
13    major: usize,
14    minor: Option<usize>,
15    patch: Option<usize>,
16}
17
18impl ApiVersion {
19    pub const fn new(major: usize, minor: Option<usize>, patch: Option<usize>) -> Self {
20        Self {
21            major,
22            minor,
23            patch,
24        }
25    }
26
27    pub fn major(&self) -> usize {
28        self.major
29    }
30
31    pub fn minor(&self) -> Option<usize> {
32        self.minor
33    }
34
35    pub fn patch(&self) -> Option<usize> {
36        self.patch
37    }
38
39    pub fn make_endpoint(&self, ep: impl AsRef<str>) -> String {
40        let ep = ep.as_ref();
41        format!(
42            "/v{}{}{}",
43            self,
44            if !ep.starts_with('/') { "/" } else { "" },
45            ep
46        )
47    }
48}
49
50impl std::fmt::Display for ApiVersion {
51    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
52        write!(f, "{}", self.major)?;
53        if let Some(minor) = self.minor {
54            write!(f, ".{minor}")?;
55        }
56        if let Some(patch) = self.patch {
57            write!(f, ".{patch}")?;
58        }
59        Ok(())
60    }
61}
62
63impl From<usize> for ApiVersion {
64    fn from(v: usize) -> Self {
65        ApiVersion {
66            major: v,
67            minor: None,
68            patch: None,
69        }
70    }
71}
72
73impl From<(usize, usize)> for ApiVersion {
74    fn from(v: (usize, usize)) -> Self {
75        ApiVersion {
76            major: v.0,
77            minor: Some(v.1),
78            patch: None,
79        }
80    }
81}
82
83impl From<(usize, usize, usize)> for ApiVersion {
84    fn from(v: (usize, usize, usize)) -> Self {
85        ApiVersion {
86            major: v.0,
87            minor: Some(v.1),
88            patch: Some(v.2),
89        }
90    }
91}
92
93impl FromStr for ApiVersion {
94    type Err = Error;
95    fn from_str(s: &str) -> Result<Self, Self::Err> {
96        let mut elems = s.split('.');
97
98        let major = if let Some(it) = elems.next() {
99            match it.parse::<usize>() {
100                Ok(it) => it,
101                Err(e) => return Err(Error::MalformedVersion(e.to_string())),
102            }
103        } else {
104            return Err(Error::MalformedVersion("expected major version".into()));
105        };
106
107        let minor = elems.next().and_then(|elem| elem.parse::<usize>().ok());
108        let patch = elems.next().and_then(|elem| elem.parse::<usize>().ok());
109
110        if elems.next().is_some() {
111            return Err(Error::MalformedVersion(
112                "unexpected extra tokens".to_string(),
113            ));
114        }
115
116        Ok(Self {
117            major,
118            minor,
119            patch,
120        })
121    }
122}
containers_api/version.rs

containers_api/
version.rs
