tenk 0.2.0

10K - A Rust library for fetching market data from multiple sources
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

//! tenk - Multi-source market data library for Rust.

pub mod client;
pub mod data;
pub mod error;
pub mod request;
pub mod sources;
pub mod traits;

pub use client::DataClient;
pub use data::{
    AdjustType, BillboardDetail, BillboardItem, BlockTradeData, BondCurrentData, CapitalFlowData,
    CapitalFlowHistory, ConvertibleBondCode, CurrentMarketData, DividendData, ETFCode,
    ETFCurrentData, ETFMarketData, ETFMinuteData, EarningsForecast, Exchange, FundHolding, IPOData,
    InstitutionalResearchData, KLineType, MarginTradingData, MarketData, MinuteData, NewsArticle,
    NewsCategory, NewsContent, NewsListResult, NewsSearchResult, OrderBookData, ResearchReportData,
    StockCode, StockConnectData, StockInfo, StockValuation, TickData, TopHolder,
};
pub use error::{DataError, DataResult};
pub use request::{RequestConfig, RequestManager};

/// Library version string.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Creates a new DataClient.
pub fn create_client() -> DataClient {
    DataClient::new()
}

/// Creates a RequestConfig with proxy.
pub fn configure_proxy(proxy_url: &str) -> RequestConfig {
    RequestConfig::default().with_proxy(proxy_url)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version() {
        assert!(!VERSION.is_empty());
    }

    #[test]
    fn test_create_client() {
        let client = create_client();
        assert_eq!(client.market_source_count(), 0);
    }

    #[test]
    fn test_configure_proxy() {
        let config = configure_proxy("http://127.0.0.1:8080");
        assert_eq!(config.proxy, Some("http://127.0.0.1:8080".to_string()));
    }
}