Skip to main content

quantwave_core/indicators/
metadata.rs

1#[derive(Debug, Clone)]
2pub struct ParamDef {
3    pub name: &'static str,
4    pub default: &'static str,
5    pub description: &'static str,
6}
7
8#[derive(Debug, Clone)]
9pub struct IndicatorMetadata {
10    pub name: &'static str,
11    /// One-sentence plain-English description of what the indicator computes.
12    pub description: &'static str,
13    /// Practical usage: when and why a trader would apply this indicator.
14    pub usage: &'static str,
15    /// Searchable topic tags (e.g. "momentum", "oscillator", "ehlers", "dsp").
16    pub keywords: &'static [&'static str],
17    /// 3-4 line authoritative summary from Ehlers' papers/books or StockCharts.
18    pub ehlers_summary: &'static str,
19    pub params: &'static [ParamDef],
20    pub formula_source: &'static str,
21    pub formula_latex: &'static str,
22    pub gold_standard_file: &'static str,
23    pub category: &'static str,
24}