Enum Indicator 

#[non_exhaustive]
pub enum Indicator {
    Sma(usize),
    Ema(usize),
    Rsi(usize),
    Macd {
        fast: usize,
        slow: usize,
        signal: usize,
    },
    Bollinger {
        period: usize,
        std_dev: f64,
    },
    Atr(usize),
    Obv,
    Vwap,
    Wma(usize),
    Dema(usize),
    Tema(usize),
    Hma(usize),
    Vwma(usize),
    Alma {
        period: usize,
        offset: f64,
        sigma: f64,
    },
    McginleyDynamic(usize),
    Stochastic {
        k_period: usize,
        k_slow: usize,
        d_period: usize,
    },
    StochasticRsi {
        rsi_period: usize,
        stoch_period: usize,
        k_period: usize,
        d_period: usize,
    },
    Cci(usize),
    WilliamsR(usize),
    Roc(usize),
    Momentum(usize),
    Cmo(usize),
    AwesomeOscillator {
        fast: usize,
        slow: usize,
    },
    CoppockCurve {
        wma_period: usize,
        long_roc: usize,
        short_roc: usize,
    },
    Adx(usize),
    Aroon(usize),
    Supertrend {
        period: usize,
        multiplier: f64,
    },
    Ichimoku {
        conversion: usize,
        base: usize,
        lagging: usize,
        displacement: usize,
    },
    ParabolicSar {
        step: f64,
        max: f64,
    },
    BullBearPower(usize),
    ElderRay(usize),
    KeltnerChannels {
        period: usize,
        multiplier: f64,
        atr_period: usize,
    },
    DonchianChannels(usize),
    TrueRange,
    ChoppinessIndex(usize),
    Mfi(usize),
    Cmf(usize),
    ChaikinOscillator,
    AccumulationDistribution,
    BalanceOfPower(Option<usize>),
}

Enum representing all available technical indicators.

This enum is used with Ticker::indicator() to calculate specific indicators over a given interval and time range.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sma(usize)

Simple Moving Average with custom period

Ema(usize)

Exponential Moving Average with custom period

Rsi(usize)

Relative Strength Index with custom period

Macd

Moving Average Convergence Divergence (fast, slow, signal periods)

Fields

fast: usize

Fast EMA period

slow: usize

Slow EMA period

signal: usize

Signal line EMA period

Bollinger

Bollinger Bands (period, standard deviation multiplier)

Fields

period: usize

SMA period

std_dev: f64

Standard deviation multiplier

Atr(usize)

Average True Range with custom period

Obv

On-Balance Volume

Vwap

Volume Weighted Average Price

Wma(usize)

Weighted Moving Average

Dema(usize)

Double Exponential Moving Average

Tema(usize)

Triple Exponential Moving Average

Hma(usize)

Hull Moving Average

Vwma(usize)

Volume Weighted Moving Average

Alma

Arnaud Legoux Moving Average

Fields

period: usize

Window period

offset: f64

Offset (typically 0.85)

sigma: f64

Sigma (typically 6.0)

McginleyDynamic(usize)

McGinley Dynamic

Stochastic

Stochastic Oscillator

Fields

k_period: usize

%K period

k_slow: usize

%K slowing period

d_period: usize

%D period (SMA of %K)

StochasticRsi

Stochastic RSI

Fields

rsi_period: usize

RSI period

stoch_period: usize

Stochastic period applied to RSI

k_period: usize

%K smoothing period

d_period: usize

%D smoothing period

Cci(usize)

Commodity Channel Index

WilliamsR(usize)

Williams %R

Roc(usize)

Rate of Change

Momentum(usize)

Momentum

Cmo(usize)

Chande Momentum Oscillator

AwesomeOscillator

Awesome Oscillator

Fields

fast: usize

Fast SMA period

slow: usize

Slow SMA period

CoppockCurve

Coppock Curve

Fields

wma_period: usize

WMA smoothing period

long_roc: usize

Long ROC period

short_roc: usize

Short ROC period

Adx(usize)

Average Directional Index

Aroon(usize)

Aroon

Supertrend

SuperTrend

Fields

period: usize

ATR period

multiplier: f64

ATR multiplier

Ichimoku

Ichimoku Cloud

Fields

conversion: usize

Conversion line period (Tenkan-sen)

base: usize

Base line period (Kijun-sen)

lagging: usize

Lagging span period (Chikou Span)

displacement: usize

Displacement for leading spans

ParabolicSar

Parabolic SAR

Fields

step: f64

Acceleration factor step

max: f64

Maximum acceleration factor

BullBearPower(usize)

Bull/Bear Power

ElderRay(usize)

Elder Ray Index

KeltnerChannels

Keltner Channels

Fields

period: usize

EMA period for middle line

multiplier: f64

ATR multiplier for bands

atr_period: usize

ATR period

DonchianChannels(usize)

Donchian Channels

TrueRange

True Range

ChoppinessIndex(usize)

Choppiness Index

Mfi(usize)

Money Flow Index

Cmf(usize)

Chaikin Money Flow

ChaikinOscillator

Chaikin Oscillator

AccumulationDistribution

Accumulation/Distribution

BalanceOfPower(Option<usize>)

Balance of Power

Implementations

impl Indicator

pub fn with_defaults(self) -> Self

Get a default instance with standard parameters

Examples

use finance_query::indicators::Indicator;

let rsi = Indicator::Rsi(14);  // 14-period RSI
let macd = Indicator::Macd { fast: 12, slow: 26, signal: 9 };

pub fn name(&self) -> &'static str

Get the human-readable name of the indicator

pub fn warmup_bars(&self) -> usize

Minimum number of data bars required before this indicator produces meaningful output.

Used by the backtesting engine’s CustomStrategy to automatically compute the warmup period instead of parsing key-name suffixes.

Examples

use finance_query::indicators::Indicator;

assert_eq!(Indicator::Sma(20).warmup_bars(), 20);
assert_eq!(Indicator::Macd { fast: 12, slow: 26, signal: 9 }.warmup_bars(), 35);
assert_eq!(Indicator::Bollinger { period: 20, std_dev: 2.0 }.warmup_bars(), 20);

Trait Implementations

impl Clone for Indicator

fn clone(&self) -> Indicator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Indicator

impl Debug for Indicator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Indicator

fn eq(&self, other: &Indicator) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Indicator