Struct EngulfingPattern 

pub struct EngulfingPattern { /* private fields */ }

Engulfing Pattern — detects bullish and bearish engulfing candlestick patterns.

A bullish engulfing occurs when:

• Previous bar is bearish (prev_close < prev_open)
• Current bar is bullish (close > open)
• Current bar’s body fully engulfs the prior bar’s body (open <= prev_close and close >= prev_open)

A bearish engulfing is the mirror: prior bullish, current bearish, full engulf.

Outputs:

• +1 → bullish engulfing
• -1 → bearish engulfing
• 0 → no pattern

Returns SignalValue::Unavailable on the first bar (requires prior bar).

Example

use fin_primitives::signals::indicators::EngulfingPattern;
use fin_primitives::signals::Signal;

let ep = EngulfingPattern::new("ep").unwrap();
assert_eq!(ep.period(), 2);

Implementations

impl EngulfingPattern

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

Errors

Never errors — provided for API consistency.

Trait Implementations

impl Signal for EngulfingPattern

fn name(&self) -> &str

Returns the name of this signal (unique within a pipeline).

fn period(&self) -> usize

Returns the number of bars required before the signal produces a value.

fn is_ready(&self) -> bool

Returns true if the signal has accumulated enough bars to produce a value.

fn update(&mut self, bar: &BarInput) -> Result<SignalValue, FinError>

Updates the signal with a BarInput and returns the current value.

fn reset(&mut self)

Resets the signal to its initial state as if no bars had been seen.

fn update_bar(&mut self, bar: &OhlcvBar) -> Result<SignalValue, FinError>

Convenience wrapper: converts bar to BarInput and calls Self::update.

fn warm_up(&mut self, bars: &[BarInput]) -> Result<SignalValue, FinError>

Feed a slice of historical bars to prime the indicator in one call.