Merge pull request #28 from ainestal/doc_test_utils

Doc test utils

Author: hugues31

src/bitstamp/utils.rs

@@ -119,6 +119,15 @@ pub fn parse_result(response: &Map<String, Value>) -> Result<Map<String, Value>>
 /// Return the currency enum associated with the
 /// string used by Bitstamp. If no currency is found,
 /// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::bitstamp::utils::get_currency_enum;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_enum("usd_balance");
+/// assert_eq!(Some(Currency::USD), currency);
+/// ```
 pub fn get_currency_enum(currency: &str) -> Option<Currency> {
     match currency {
         "usd_balance" => Some(Currency::USD),
@@ -128,3 +137,25 @@ pub fn get_currency_enum(currency: &str) -> Option<Currency> {
         _ => None,
     }
 }
+
+/// Return the currency string associated with the
+/// enum used by Bitstamp. If no currency is found,
+/// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::bitstamp::utils::get_currency_string;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_string(Currency::USD);
+/// assert_eq!(currency, Some("USD".to_string()));
+/// ```
+pub fn get_currency_string(currency: Currency) -> Option<String> {
+    match currency {
+        Currency::USD => Some("USD".to_string()),
+        Currency::BTC => Some("BTC".to_string()),
+        Currency::EUR => Some("EUR".to_string()),
+        Currency::XRP => Some("XRP".to_string()),
+        _ => None,
+    }
+}

src/kraken/utils.rs

@@ -140,7 +140,18 @@ pub fn parse_result(response: &Map<String, Value>) -> Result<Map<String, Value>>
     }
 }
 
+/// Return the currency enum associated with the
+/// string used by Kraken. If no currency is found,
 /// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::kraken::utils::get_currency_enum;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_enum("ZUSD");
+/// assert_eq!(Some(Currency::USD), currency);
+/// ```
 pub fn get_currency_enum(currency: &str) -> Option<Currency> {
     match currency {
         "ZEUR" => Some(Currency::EUR),
@@ -166,3 +177,41 @@ pub fn get_currency_enum(currency: &str) -> Option<Currency> {
         _ => None,
     }
 }
+
+/// Return the currency String associated with the
+/// string used by Kraken. If no currency is found,
+/// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::kraken::utils::get_currency_string;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_string(Currency::BTC);
+/// assert_eq!(currency, Some("XXBT".to_string()));
+/// ```
+pub fn get_currency_string(currency: Currency) -> Option<String> {
+    match currency {
+        Currency::EUR => Some("ZEUR".to_string()),
+        Currency::CAD => Some("ZCAD".to_string()),
+        Currency::GBP => Some("ZGBP".to_string()),
+        Currency::JPY => Some("ZJPY".to_string()),
+        Currency::USD => Some("ZUSD".to_string()),
+        Currency::DASH => Some("XDASH".to_string()),
+        Currency::ETC => Some("XETC".to_string()),
+        Currency::ETH => Some("XETH".to_string()),
+        Currency::GNO => Some("XGNO".to_string()),
+        Currency::ICN => Some("XICN".to_string()),
+        Currency::LTC => Some("XLTC".to_string()),
+        Currency::MLN => Some("XMLN".to_string()),
+        Currency::REP => Some("XREP".to_string()),
+        Currency::USDT => Some("XUSDT".to_string()),
+        Currency::BTC => Some("XXBT".to_string()),
+        Currency::XDG => Some("XXDG".to_string()),
+        Currency::XLM => Some("XXLM".to_string()),
+        Currency::XMR => Some("XXMR".to_string()),
+        Currency::XRP => Some("XXRP".to_string()),
+        Currency::ZEC => Some("XZEC".to_string()),
+        _ => None,
+    }
+}

src/poloniex/utils.rs

@@ -153,6 +153,15 @@ pub fn parse_result(response: &Map<String, Value>) -> Result<Map<String, Value>>
 /// Return the currency enum associated with the
 /// string used by Poloniex. If no currency is found,
 /// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::poloniex::utils::get_currency_enum;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_enum("BTC").unwrap();
+/// assert_eq!(currency, Currency::BTC);
+/// ```
 pub fn get_currency_enum(currency: &str) -> Option<Currency> {
     match currency {
         "AMP" => Some(Currency::AMP),
@@ -169,3 +178,32 @@ pub fn get_currency_enum(currency: &str) -> Option<Currency> {
         _ => None,
     }
 }
+
+/// Return the currency string associated with the
+/// enum used by Poloniex. If no currency is found,
+/// return None
+/// # Examples
+///
+/// ```
+/// use coinnect::poloniex::utils::get_currency_string;
+/// use coinnect::currency::Currency;
+///
+/// let currency = get_currency_string(Currency::BTC);
+/// assert_eq!(currency, Some("BTC".to_string()));
+/// ```
+pub fn get_currency_string(currency: Currency) -> Option<String> {
+    match currency {
+        Currency::AMP => Some("AMP".to_string()),
+        Currency::BTC => Some("BTC".to_string()),
+        Currency::ARDR => Some("ARDR".to_string()),
+        Currency::ETH => Some("ETH".to_string()),
+        Currency::ETC => Some("ETC".to_string()),
+        Currency::LBC => Some("LBC".to_string()),
+        Currency::XMR => Some("XMR".to_string()),
+        Currency::XPM => Some("XPM".to_string()),
+        Currency::XRP => Some("XRP".to_string()),
+        Currency::XVC => Some("XVC".to_string()),
+        Currency::ZEC => Some("ZEC".to_string()),
+        _ => None,
+    }
+}