Struct CandlePattern 

pub struct CandlePattern { /* private fields */ }

Candle Pattern — detects common single-bar and two-bar price action patterns.

Returns:

• +2 — Bullish Engulfing (two-bar): current bullish body engulfs prior bearish body
• +1 — Hammer: small body at top of range, long lower wick (≥ 2× body), no upper wick
• -1 — Shooting Star: small body at bottom of range, long upper wick (≥ 2× body)
• -2 — Bearish Engulfing: current bearish body engulfs prior bullish body
• 0 — No pattern detected this bar

Returns SignalValue::Unavailable until the second bar (needed for engulfing patterns).

Example

use fin_primitives::signals::indicators::CandlePattern;
use fin_primitives::signals::Signal;

let cp = CandlePattern::new("cp").unwrap();
assert_eq!(cp.period(), 2);

Implementations

impl CandlePattern

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

Creates a new CandlePattern.

Errors

Always succeeds.

Trait Implementations

impl Signal for CandlePattern

fn name(&self) -> &str

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

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

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

fn is_ready(&self) -> bool

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

fn period(&self) -> usize

Returns the number of bars required before the signal produces a 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.