Trait yata::core::IndicatorConfig

pub trait IndicatorConfig: Clone {
    type Instance: IndicatorInstance<Config = Self>;

    pub const NAME: &'static str;

    pub fn validate(&self) -> bool;
    pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>;
    pub fn size(&self) -> (u8, u8);
    pub fn init<T: OHLCV>(
        self, 
        initial_value: &T
    ) -> Result<Self::Instance, Error>;

    pub fn name(&self) -> &'static str { ... }
    pub fn init_fn<'a, T: OHLCV>(
        self, 
        initial_value: &'a T
    ) -> Result<Box<dyn FnMut(&'a T) -> IndicatorResult>, Error>
    where
        Self: 'static,
    { ... }
    pub fn over<T, S>(self, inputs: S) -> Result<Vec<IndicatorResult>, Error>
    where
        T: OHLCV,
        S: AsRef<[T]>,
        Self: Sized,
    { ... }
}

Each indicator has it's own Configuration with parameters

Each that config should implement IndicatorConfig trait

See example with Example Indicator

Associated Types

type Instance: IndicatorInstance<Config = Self>

Type of State

Loading content...

Associated Constants

pub const NAME: &'static str

Name of an indicator

Loading content...

Required methods

pub fn validate(&self) -> bool

Validates if Configuration is OK

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

Dynamically sets Configuration parameters

pub fn size(&self) -> (u8, u8)

Returns an IndicatorResult size processing by the indicator (count of raw values, count of signals)

pub fn init<T: OHLCV>(self, initial_value: &T) -> Result<Self::Instance, Error>

Initializes the State based on current Configuration

Loading content...

Provided methods

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

Returns a name of the indicator

pub fn init_fn<'a, T: OHLCV>(
    self,
    initial_value: &'a T
) -> Result<Box<dyn FnMut(&'a T) -> IndicatorResult>, Error> where
    Self: 'static, 

Creates an IndicatorInstance function from this IndicatorConfig.

pub fn over<T, S>(self, inputs: S) -> Result<Vec<IndicatorResult>, Error> where
    T: OHLCV,
    S: AsRef<[T]>,
    Self: Sized, 

Evaluates indicator config over sequence of OHLC and returns sequence of IndicatorResults

use yata::prelude::*;
use yata::helpers::{RandomCandles};
use yata::indicators::Trix;

let candles: Vec<_> = RandomCandles::new().take(10).collect();
let trix = Trix::default();
let results = trix.over(&candles).unwrap();
println!("{:?}", results);

Loading content...

Implementors

impl IndicatorConfig for Example

Implementing IndicatorConfig trait

type Instance = ExampleInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, _candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

Validates config values to be consistent

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

Sets attributes of config by given name and value by String

pub fn size(&self) -> (u8, u8)

Our indicator will return single raw value and two signals

impl IndicatorConfig for Aroon

type Instance = AroonInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for AverageDirectionalIndex

type Instance = AverageDirectionalIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for AwesomeOscillator

type Instance = AwesomeOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for BollingerBands

type Instance = BollingerBandsInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for ChaikinMoneyFlow

type Instance = ChaikinMoneyFlowInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for ChaikinOscillator

type Instance = ChaikinOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for ChandeKrollStop

type Instance = ChandeKrollStopInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for ChandeMomentumOscillator

type Instance = ChandeMomentumOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for CommodityChannelIndex

type Instance = CommodityChannelIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for CoppockCurve

type Instance = CoppockCurveInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for DetrendedPriceOscillator

type Instance = DetrendedPriceOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for EaseOfMovement

type Instance = EaseOfMovementInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for EldersForceIndex

type Instance = EldersForceIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for Envelopes

type Instance = EnvelopesInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for FisherTransform

type Instance = FisherTransformInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for HullMovingAverage

type Instance = HullMovingAverageInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for IchimokuCloud

type Instance = IchimokuCloudInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for Kaufman

type Instance = KaufmanInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for KeltnerChannel

type Instance = KeltnerChannelInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for KlingerVolumeOscillator

type Instance = KlingerVolumeOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for KnowSureThing

type Instance = KnowSureThingInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for MACD

type Instance = MACDInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for MomentumIndex

type Instance = MomentumIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for MoneyFlowIndex

type Instance = MoneyFlowIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for ParabolicSAR

type Instance = ParabolicSARInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for PivotReversalStrategy

type Instance = PivotReversalStrategyInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for PriceChannelStrategy

type Instance = PriceChannelStrategyInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for RelativeStrengthIndex

type Instance = RelativeStrengthIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for RelativeVigorIndex

type Instance = RelativeVigorIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for SMIErgodicIndicator

type Instance = SMIErgodicIndicatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for StochasticOscillator

type Instance = StochasticOscillatorInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for TrendStrengthIndex

type Instance = TrendStrengthIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for Trix

type Instance = TRIXInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for TrueStrengthIndex

type Instance = TrueStrengthIndexInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

impl IndicatorConfig for WoodiesCCI

type Instance = WoodiesCCIInstance

pub const NAME: &'static str

pub fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

pub fn validate(&self) -> bool

pub fn set(&mut self, name: &str, value: String) -> Result<(), Error>

pub fn size(&self) -> (u8, u8)

Loading content...