tcmb_evds 0.1.0

A Rust crate for reaching the database of The Central Bank of The Republic of Turkey (CBRT).
Documentation 
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use super::*;

/// provides aggregation type options to create an element of frequency formulas.
///
/// This enum is used in [`AdvancedProcesses`](crate::evds_currency::frequency_formulas::AdvancedProcesses) for 
/// [`get_advanced_data`](crate::evds_currency::CurrencySeries::get_advanced_data) function.
pub enum AggregationType {
    Average,
    Minimum,
    Maximum,
    Beginning,
    End,
    Cumulative,
}

impl ToString for AggregationType {
    fn to_string(&self) -> String {
        match self {
            &Self::Average => String::from("avg"),
            &Self::Minimum => String::from("min"),
            &Self::Maximum => String::from("max"),
            &Self::Beginning => String::from("first"),
            &Self::End => String::from("last"),
            &Self::Cumulative => String::from("sum"),
        }
    }
}

impl traits::MakingUrlFormat for AggregationType {
    fn generate_url_format(&self) -> String {
        format!("aggregationTypes={}", self.to_string())
    }
}


/// provides formula options to create an element of frequency formulas.
///
/// This enum is used in [`AdvancedProcesses`](crate::evds_currency::frequency_formulas::AdvancedProcesses) for 
/// [`get_advanced_data`](crate::evds_currency::CurrencySeries::get_advanced_data) function.
pub enum Formula {
    Level, 
    PercentageChange, 
    Difference, 
    YearToYearPercentChange, 
    YearToYearDifferences,
    PercentageChangeByEndOfPreviousYear, 
    DifferenceByEndOfPreviousYear,
    MovingAverage, 
    MovingSum,
}

impl ToString for Formula {
    fn to_string(&self) -> String {
        match self {
            &Self::Level => "0".to_string(),
            &Self::PercentageChange => "1".to_string(),
            &Self::Difference => "2".to_string(),
            &Self::YearToYearPercentChange => "3".to_string(),
            &Self::YearToYearDifferences => "4".to_string(),
            &Self::PercentageChangeByEndOfPreviousYear => "5".to_string(),
            &Self::DifferenceByEndOfPreviousYear => "6".to_string(),
            &Self::MovingAverage => "7".to_string(),
            &Self::MovingSum => "8".to_string(),
        }
    }
} 

impl traits::MakingUrlFormat for Formula {
    fn generate_url_format(&self) -> String {
        format!("formulas={}", self.to_string())
    }
}


/// provides data frequency options to create an element of frequency formulas.
///
/// This struct is used for [`AdvancedProcesses`](crate::evds_currency::frequency_formulas::AdvancedProcesses) for 
/// [`get_advanced_data`](crate::evds_currency::CurrencySeries::get_advanced_data) function.
pub enum DataFrequency {
    Daily, 
    Business, 
    WeeklyFriday,
    TwiceMonthly, 
    Monthly, 
    Quarterly,
    SemiAnnual, 
    Annual,
}

impl ToString for DataFrequency {
    fn to_string(&self) -> String {
        match self {
            &Self::Daily => "1".to_string(),
            &Self::Business => "2".to_string(),
            &Self::WeeklyFriday => "3".to_string(),
            &Self::TwiceMonthly => "4".to_string(),
            &Self::Monthly => "5".to_string(),
            &Self::Quarterly => "6".to_string(),
            &Self::SemiAnnual => "7".to_string(),
            &Self::Annual => "8".to_string(),
        }
    }
}

impl traits::MakingUrlFormat for DataFrequency {
    fn generate_url_format(&self) -> String {
        format!("frequency={}", self.to_string())
    }
}


/// contains the elements of frequency formulas.
///
/// This struct is used as an argument for 
/// [`get_advanced_data`](crate::evds_currency::CurrencySeries::get_advanced_data) function.
pub struct AdvancedProcesses {
    pub aggregation_type: AggregationType,
    pub formula: Formula,
    pub data_frequency: DataFrequency,
}

impl AdvancedProcesses {
    /// creates frequency formulas structure named AdvancedProcess.
    /// 
    /// # Example
    /// ```
    ///     use tcmb_evds::evds_currency::frequency_formulas::*;
    ///
    ///     let aggregation_type = AggregationType::Average;
    ///     let formula = Formula::Level;
    ///     let data_frequency = DataFrequency::Monthly;
    ///
    ///     let advanced_processes = AdvancedProcesses::from(aggregation_type, formula, data_frequency);
    /// ```
    pub fn from(
        aggregation_type: AggregationType, 
        formula: Formula, 
        data_frequency: DataFrequency
    ) -> AdvancedProcesses {
        AdvancedProcesses {
            aggregation_type,
            formula,
            data_frequency
        }
    }

    pub(crate) fn get_aggregation_type_as_url_format(&self) -> String {
        self.aggregation_type.generate_url_format()
    }

    pub(crate) fn get_formula_as_url_format(&self) -> String {
        self.formula.generate_url_format()
    }

    pub(crate) fn get_data_frequency_as_url_format(&self) -> String {
        self.data_frequency.generate_url_format()
    }
}