ohlcv 0.0.2

Data collector library for fetching, analyzing, predicting and charting time series data (OHLC) of cryptocurrencies from various exchanges
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use std::fmt;

use serde::{Deserialize, Serialize};

use crate::Currency;

/// Represents a cryptocurrency and its quote currency.
#[derive(Clone, Debug, Eq, Serialize, Deserialize)]
pub struct Coin {
    symbol: Box<str>,
    name: Box<str>,
    currency: Currency,
}

impl Coin {
    /// Create a new [`Coin`].
    #[must_use]
    pub fn new(symbol: impl Into<String>, name: impl Into<String>, currency: Currency) -> Self {
        Self {
            symbol: symbol.into().to_uppercase().into_boxed_str(),
            name: name.into().into_boxed_str(),
            currency,
        }
    }

    /// The symbol of the coin.
    ///
    /// The symbol is used to identify the coin in the database and is part of
    /// the table name.
    #[must_use]
    #[inline]
    pub const fn symbol(&self) -> &str {
        &self.symbol
    }

    /// The human-readable name of the coin.
    #[must_use]
    #[inline]
    pub const fn name(&self) -> &str {
        &self.name
    }

    /// The quote currency of the coin.
    #[must_use]
    #[inline]
    pub const fn currency(&self) -> Currency {
        self.currency
    }

    /// The prefix of the table name.
    #[must_use]
    #[inline]
    pub const fn table_prefix() -> &'static str {
        "candles"
    }

    /// The table name of the coin.
    ///
    /// The table name is used to identify the coin in the database. It is
    /// constructed from the table prefix, the symbol and the currency.
    ///
    /// # Examples
    ///
    /// ```
    /// use ohlcv::Coin;
    /// use ohlcv::Currency;
    ///
    /// let coin = Coin::new("BTC", "Bitcoin", Currency::USD);
    /// assert_eq!(coin.table_name(), "candles_btc_usd");
    /// ```
    #[must_use]
    pub fn table_name(&self) -> String {
        format!(
            "{}_{}_{}",
            Self::table_prefix(),
            self.symbol.to_lowercase(),
            self.currency.to_string().to_lowercase()
        )
    }
}

impl fmt::Display for Coin {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if f.alternate() {
            write!(f, "{} ({})", self.name, self.symbol)
        } else {
            write!(f, "{}", self.symbol)
        }
    }
}

impl PartialEq for Coin {
    fn eq(&self, other: &Self) -> bool {
        self.symbol == other.symbol
    }
}