mkt_types/
exchange.rs

1use std::fmt;
2
3use strum_macros::{Display, EnumString, IntoStaticStr};
4
5#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
6#[derive(
7    Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Display, EnumString, IntoStaticStr,
8)]
9#[strum(serialize_all = "kebab-case", ascii_case_insensitive)]
10pub enum KnownExchange {
11    Binance,
12    Bybit,
13    Bitget,
14    Mexc,
15    Okx,
16}
17
18#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
19#[non_exhaustive]
20#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
21pub struct ExtensionExchangeId(String);
22
23impl ExtensionExchangeId {
24    pub fn new(value: impl Into<String>) -> Result<Self, ExchangeIdParseError> {
25        let value = value.into();
26        if value.is_empty() {
27            return Err(ExchangeIdParseError::Empty);
28        }
29
30        let valid_format = value
31            .bytes()
32            .all(|byte| byte.is_ascii_lowercase() || byte.is_ascii_digit() || byte == b'-');
33        if valid_format {
34            Ok(Self(value))
35        } else {
36            Err(ExchangeIdParseError::InvalidExtensionId(value))
37        }
38    }
39}
40
41impl fmt::Display for ExtensionExchangeId {
42    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
43        f.write_str(&self.0)
44    }
45}
46
47#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
48#[non_exhaustive]
49#[derive(Debug, Clone, PartialEq, Eq)]
50pub enum ExchangeIdParseError {
51    Empty,
52    InvalidExtensionId(String),
53}
54
55impl fmt::Display for ExchangeIdParseError {
56    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
57        match self {
58            Self::Empty => f.write_str("exchange id cannot be empty"),
59            Self::InvalidExtensionId(value) => write!(f, "invalid extension exchange id: {value}"),
60        }
61    }
62}
63
64impl std::error::Error for ExchangeIdParseError {}
65
66#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
67#[non_exhaustive]
68#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
69pub enum ExchangeId {
70    Known(KnownExchange),
71    Extension(ExtensionExchangeId),
72}
73
74impl ExchangeId {
75    pub fn as_str(&self) -> &str {
76        match self {
77            Self::Known(id) => (*id).into(),
78            Self::Extension(id) => &id.0,
79        }
80    }
81}
82
83impl From<KnownExchange> for ExchangeId {
84    fn from(value: KnownExchange) -> Self {
85        Self::Known(value)
86    }
87}
88
89impl TryFrom<&str> for ExchangeId {
90    type Error = ExchangeIdParseError;
91
92    fn try_from(value: &str) -> Result<Self, Self::Error> {
93        match value.parse::<KnownExchange>() {
94            Ok(id) => Ok(Self::Known(id)),
95            Err(_) => ExtensionExchangeId::new(value).map(Self::Extension),
96        }
97    }
98}
99
100impl TryFrom<String> for ExchangeId {
101    type Error = ExchangeIdParseError;
102
103    fn try_from(value: String) -> Result<Self, Self::Error> {
104        Self::try_from(value.as_str())
105    }
106}
107
108impl fmt::Display for ExchangeId {
109    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
110        f.write_str(self.as_str())
111    }
112}
113
114#[cfg(test)]
115mod tests {
116    use super::{ExchangeId, ExchangeIdParseError, KnownExchange};
117
118    #[test]
119    fn known_exchange_ids_are_normalized() {
120        assert_eq!(
121            ExchangeId::try_from("OKX").expect("known exchange"),
122            ExchangeId::Known(KnownExchange::Okx)
123        );
124    }
125
126    #[test]
127    fn extension_exchange_ids_must_be_canonical() {
128        let err = ExchangeId::try_from("MyDesk").expect_err("uppercase extension id should fail");
129
130        assert!(matches!(err, ExchangeIdParseError::InvalidExtensionId(_)));
131        assert_eq!(
132            ExchangeId::try_from("my-desk").expect("canonical extension id"),
133            ExchangeId::Extension(super::ExtensionExchangeId::new("my-desk").expect("valid id"))
134        );
135    }
136}
mkt_types/exchange.rs

mkt_types/
exchange.rs
