Skip to main content

IndicatorRef

Struct IndicatorRef 

Source
pub struct IndicatorRef {
    pub name: String,
}
Expand description

Reference to an indicator within a strategy, with convenience methods for building conditions.

Fields§

§name: String

Implementations§

Source§

impl IndicatorRef

Source

pub fn new(name: impl Into<String>) -> Self

Create a new indicator reference.

Source

pub fn sma(period: usize) -> Self

SMA convenience constructor.

Source

pub fn ema(period: usize) -> Self

EMA convenience constructor.

Source

pub fn macd(fast: usize, slow: usize, signal: usize) -> Self

MACD convenience constructor.

Source

pub fn macd_signal(fast: usize, slow: usize, signal: usize) -> Self

MACD signal line convenience constructor.

Source

pub fn rsi(period: usize) -> Self

RSI convenience constructor.

Source

pub fn stoch_k(k_period: usize, d_period: usize) -> Self

Stochastic %K convenience constructor.

Source

pub fn stoch_d(k_period: usize, d_period: usize) -> Self

Stochastic %D convenience constructor.

Source

pub fn bb_upper(period: usize, std_dev: f64) -> Self

Bollinger Bands upper convenience constructor.

Source

pub fn bb_middle(period: usize, std_dev: f64) -> Self

Bollinger Bands middle convenience constructor.

Source

pub fn bb_lower(period: usize, std_dev: f64) -> Self

Bollinger Bands lower convenience constructor.

Source

pub fn atr(period: usize) -> Self

ATR convenience constructor.

Source

pub fn volume_sma(period: usize) -> Self

Volume SMA convenience constructor.

Source

pub fn obv() -> Self

OBV convenience constructor.

Source

pub fn pivot_points() -> Self

Pivot Points convenience constructor.

Source

pub fn adx(period: usize) -> Self

ADX convenience constructor.

Source

pub fn wma(period: usize) -> Self

WMA convenience constructor.

Source

pub fn dema(period: usize) -> Self

DEMA convenience constructor.

Source

pub fn tema(period: usize) -> Self

TEMA convenience constructor.

Source

pub fn cci(period: usize) -> Self

CCI convenience constructor.

Source

pub fn williams_r(period: usize) -> Self

Williams %R convenience constructor.

Source

pub fn roc(period: usize) -> Self

ROC convenience constructor.

Source

pub fn stddev(period: usize) -> Self

Standard Deviation convenience constructor.

Source

pub fn crosses_above(self, value: f64) -> ConditionNode

Create a condition: this indicator crosses above a value.

Source

pub fn crosses_above_indicator(self, other: IndicatorRef) -> ConditionNode

Create a condition: this indicator crosses above another indicator.

Source

pub fn crosses_below(self, value: f64) -> ConditionNode

Create a condition: this indicator crosses below a value.

Source

pub fn crosses_below_indicator(self, other: IndicatorRef) -> ConditionNode

Create a condition: this indicator crosses below another indicator.

Source

pub fn is_above(self, value: f64) -> ConditionNode

Create a condition: this indicator is above a value.

Source

pub fn is_above_indicator(self, other: IndicatorRef) -> ConditionNode

Create a condition: this indicator is above another indicator.

Source

pub fn is_below(self, value: f64) -> ConditionNode

Create a condition: this indicator is below a value.

Source

pub fn is_below_indicator(self, other: IndicatorRef) -> ConditionNode

Create a condition: this indicator is below another indicator.

Source

pub fn equals(self, value: f64) -> ConditionNode

Create a condition: this indicator equals a value (within epsilon).

Source

pub fn equals_indicator(self, other: IndicatorRef) -> ConditionNode

Create a condition: this indicator equals another indicator (within epsilon).

Source

pub fn is_between(self, lower: f64, upper: f64) -> ConditionNode

Create a condition: this indicator is between two values.

Source

pub fn is_rising(self, bars: u32) -> ConditionNode

Create a condition: this indicator is rising over bars bars.

Source

pub fn is_falling(self, bars: u32) -> ConditionNode

Create a condition: this indicator is falling over bars bars.

Source

pub fn scaled(self, multiplier: f64) -> ScaledIndicatorRef

Create a condition: this indicator scaled by a multiplier is above a value.

Trait Implementations§

Source§

impl Clone for IndicatorRef

Source§

fn clone(&self) -> IndicatorRef

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IndicatorRef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for IndicatorRef

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for IndicatorRef

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for IndicatorRef

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for IndicatorRef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,