finance-query 2.5.1

A Rust library for querying financial data
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

//! Error types for backtesting operations.

use thiserror::Error;

/// Backtest-specific errors
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum BacktestError {
    /// Invalid configuration parameter
    #[error("Invalid parameter '{param}': {reason}")]
    InvalidParameter {
        /// Parameter name
        param: String,
        /// Reason for invalidity
        reason: String,
    },

    /// Insufficient data for backtest
    #[error("Insufficient data: need at least {need} candles, got {got}")]
    InsufficientData {
        /// Minimum required candles
        need: usize,
        /// Actual candles provided
        got: usize,
    },

    /// Strategy error during execution
    #[error("Strategy error: {0}")]
    StrategyError(String),

    /// Indicator calculation failed
    #[error("Indicator calculation failed: {0}")]
    IndicatorError(#[from] crate::indicators::IndicatorError),

    /// Chart data fetch failed
    #[error("Failed to fetch chart data: {0}")]
    ChartError(String),

    /// Position management error
    #[error("Position error: {0}")]
    PositionError(String),
}

/// Result type for backtest operations
pub type Result<T> = std::result::Result<T, BacktestError>;

impl BacktestError {
    /// Create an invalid parameter error
    pub fn invalid_param(param: impl Into<String>, reason: impl Into<String>) -> Self {
        Self::InvalidParameter {
            param: param.into(),
            reason: reason.into(),
        }
    }

    /// Create an insufficient data error
    pub fn insufficient_data(need: usize, got: usize) -> Self {
        Self::InsufficientData { need, got }
    }

    /// Create a strategy error
    pub fn strategy(msg: impl Into<String>) -> Self {
        Self::StrategyError(msg.into())
    }

    /// Create a chart error
    pub fn chart(msg: impl Into<String>) -> Self {
        Self::ChartError(msg.into())
    }

    /// Create a position error
    pub fn position(msg: impl Into<String>) -> Self {
        Self::PositionError(msg.into())
    }
}

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

    #[test]
    fn test_invalid_param_error() {
        let err = BacktestError::invalid_param("capital", "must be positive");
        assert!(err.to_string().contains("capital"));
        assert!(err.to_string().contains("must be positive"));
    }

    #[test]
    fn test_insufficient_data_error() {
        let err = BacktestError::insufficient_data(50, 10);
        assert!(err.to_string().contains("50"));
        assert!(err.to_string().contains("10"));
    }
}