finql 0.12.0

A quantitative finance toolbox
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

use async_trait::async_trait;
///! Data handler trait for market quotes
use chrono::{DateTime, Local};
use std::sync::Arc;

use super::AssetHandler;
use super::DataError;
use super::{Currency, CurrencyISOCode, Quote, Ticker};

/// Handler for globally available market quotes data
#[async_trait]
pub trait QuoteHandler: AssetHandler {
    fn into_arc_dispatch(self: Arc<Self>) -> Arc<dyn AssetHandler + Send + Sync>;

    // insert, get, update and delete for market data sources
    async fn insert_ticker(&self, ticker: &Ticker) -> Result<i32, DataError>;
    async fn get_ticker_id(&self, ticker: &str) -> Option<i32>;
    async fn insert_if_new_ticker(&self, ticker: &Ticker) -> Result<i32, DataError>;
    async fn get_ticker_by_id(&self, id: i32) -> Result<Ticker, DataError>;
    async fn get_all_ticker(&self) -> Result<Vec<Ticker>, DataError>;
    async fn get_all_ticker_for_source(&self, source: &str) -> Result<Vec<Ticker>, DataError>;

    /// Get all ticker that belong to a given asset specified by its asset ID
    async fn get_all_ticker_for_asset(&self, asset_id: i32) -> Result<Vec<Ticker>, DataError>;

    async fn update_ticker(&self, ticker: &Ticker) -> Result<(), DataError>;
    async fn delete_ticker(&self, id: i32) -> Result<(), DataError>;

    /// Insert, get, update and delete for market data sources
    async fn insert_quote(&self, quote: &Quote) -> Result<i32, DataError>;

    /// Get the last quote in database for a specific currency iso code on or before the given time
    async fn get_last_fx_quote_before(
        &self,
        curr: &CurrencyISOCode,
        time: DateTime<Local>,
    ) -> Result<(Quote, Currency), DataError>;

    /// Get the last quote in database for a specific asset id on or before the given time
    async fn get_last_quote_before_by_id(
        &self,
        asset_id: i32,
        time: DateTime<Local>,
    ) -> Result<(Quote, Currency), DataError>;

    /// Get all quotes within a time range for a specific asset id
    async fn get_quotes_in_range_by_id(
        &self,
        asset_id: i32,
        start: DateTime<Local>,
        end: DateTime<Local>,
    ) -> Result<Vec<(Quote, i32)>, DataError>;

    async fn get_all_quotes_for_ticker(&self, ticker_id: i32) -> Result<Vec<Quote>, DataError>;
    async fn update_quote(&self, quote: &Quote) -> Result<(), DataError>;
    async fn delete_quote(&self, id: i32) -> Result<(), DataError>;
    async fn remove_duplicates(&self) -> Result<(), DataError>;
}