Enum AlertCondition 

#[non_exhaustive]
pub enum AlertCondition {
    StrategyFills(String),
    Crossing(f64),
    CrossingUp(f64),
    CrossingDown(f64),
    Above(f64),
    Below(f64),
    EnteringChannel {
        lower: f64,
        upper: f64,
    },
    ExitingChannel {
        lower: f64,
        upper: f64,
    },
    InsideChannel {
        lower: f64,
        upper: f64,
    },
    OutsideChannel {
        lower: f64,
        upper: f64,
    },
    MovingBy {
        value: f64,
        bars: u32,
    },
    MovingByPercent {
        percent: f64,
        bars: u32,
    },
    Compare {
        other: AlertSource,
        comparison: AlertComparison,
    },
    Channel {
        boundaries: [AlertSource; 2],
        comparison: AlertChannelComparison,
    },
    VolumeAboveAverage {
        multiplier: f64,
        bars: u32,
    },
}

When an alert fires, judged on its source for each subject symbol. Each variant states its rule so that a host and a server evaluate it alike. Levels are finite and in the symbol’s price units.

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.

StrategyFills(String)

Each fill of the host’s uniquely named strategy run. Feed Backtest::update results to AlertEngine::strategy_fills with the same run id. Uses the price source, no additional rules, and frequency EveryTime (the constructor default) or Once. No bars evaluate it.

Crossing(f64)

The previous value was strictly below or above the level and the current value reaches or passes it, in either direction.

CrossingUp(f64)

The previous price was below the level and the current price is at or above it.

CrossingDown(f64)

The previous price was above the level and the current price is at or below it.

Above(f64)

The price is above the level.

Below(f64)

The price is below the level.

EnteringChannel

Previous value was outside the inclusive channel, current value is inside it.

Fields

lower: f64

Inclusive lower boundary, strictly below upper.

upper: f64

Inclusive upper boundary.

ExitingChannel

Previous value was inside the inclusive channel, current value is outside it.

Fields

lower: f64

Inclusive lower boundary, strictly below upper.

upper: f64

Inclusive upper boundary.

InsideChannel

The current value is inside the inclusive channel, lower <= value <= upper, whatever the previous value was.

Fields

lower: f64

Inclusive lower boundary, strictly below upper.

upper: f64

Inclusive upper boundary.

OutsideChannel

The current value is outside the inclusive channel, below lower or above upper, whatever the previous value was.

Fields

lower: f64

Inclusive lower boundary, strictly below upper.

upper: f64

Inclusive upper boundary.

MovingBy

Signed change from bars bars ago reaches value: at least for positive, at most for negative.

Fields

value: f64

Signed, nonzero change in source units.

bars: u32

Number of bars back, at least one.

MovingByPercent

Signed percentage change, 100 * (current - previous) / abs(previous), over bars bars. A zero previous value cannot satisfy this condition.

Fields

percent: f64

Signed, nonzero percentage, with 1 meaning 1%.

bars: u32

Number of bars back, at least one.

Compare

Compare against another output on the same bar, using its previous value for crossings.

Fields

other: AlertSource

The second output on the same symbol and bar.

comparison: AlertComparison

The required relationship between the outputs.

Channel

Test against two boundaries resolved on each evaluated bar. The boundaries may change order; their minimum and maximum define the inclusive channel. Missing, non-finite or coincident boundaries cannot satisfy the condition. On a new bar, transitions resolve the source and both boundaries at the preceding bar again. Within a bar they compare with the previous evaluation, just as a crossing does.

Fields

boundaries: [AlertSource; 2]

Stable sources of the two boundary lines, retained through drawing edits and storage.

comparison: AlertChannelComparison

State or transition to test.

VolumeAboveAverage

Current volume exceeds multiplier times the mean of the preceding bars completed volumes.

Fields

multiplier: f64

Positive, finite multiple of the preceding mean volume.

bars: u32

Number of preceding bars in the mean, at least one.

Implementations

impl AlertCondition

pub fn is_valid(&self) -> bool

Whether levels are finite and ordered, lookbacks positive, and referenced ids nonempty.

pub fn level(&self) -> Option<f64>

The single horizontal threshold, if the condition has one.

Trait Implementations

impl Clone for AlertCondition

fn clone(&self) -> AlertCondition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlertCondition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlertCondition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AlertCondition

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

Formats the value using the given formatter.

impl PartialEq for AlertCondition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AlertCondition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AlertCondition