Enum CandlePattern 

#[non_exhaustive]
pub enum CandlePattern {
    MorningStar,
    EveningStar,
    ThreeWhiteSoldiers,
    ThreeBlackCrows,
    BullishEngulfing,
    BearishEngulfing,
    BullishHarami,
    BearishHarami,
    PiercingLine,
    DarkCloudCover,
    TweezerTop,
    TweezerBottom,
    Doji,
    SpinningTop,
    BullishMarubozu,
    BearishMarubozu,
    Hammer,
    InvertedHammer,
    HangingMan,
    ShootingStar,
}

A detected candlestick pattern.

Returned per-bar by patterns. Each bar carries at most one pattern; three-bar patterns take precedence over two-bar, which take precedence over one-bar.

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.

MorningStar

Bullish three-bar reversal: large bearish → small indecision star → large bullish that closes above the first bar’s midpoint.

EveningStar

Bearish three-bar reversal: large bullish → small indecision star → large bearish that closes below the first bar’s midpoint.

ThreeWhiteSoldiers

Bullish continuation: three consecutive bullish bars, each opening within the prior bar’s body and closing at a new high.

ThreeBlackCrows

Bearish continuation: three consecutive bearish bars, each opening within the prior bar’s body and closing at a new low.

BullishEngulfing

Bullish reversal: bearish bar followed by a larger bullish bar whose body fully engulfs the prior bar’s body.

BearishEngulfing

Bearish reversal: bullish bar followed by a larger bearish bar whose body fully engulfs the prior bar’s body.

BullishHarami

Bullish reversal: large bearish bar followed by a smaller bar (any colour, including Doji) whose body is contained within the prior bar’s body. A Doji inner bar is a “Harami Cross” — an even stronger signal.

BearishHarami

Bearish reversal: large bullish bar followed by a smaller bar (any colour, including Doji) whose body is contained within the prior bar’s body. A Doji inner bar is a “Harami Cross” — an even stronger signal.

PiercingLine

Bullish reversal: bearish bar followed by a bullish bar that opens below the prior close and closes above the prior body’s midpoint.

DarkCloudCover

Bearish reversal: bullish bar followed by a bearish bar that opens above the prior close and closes below the prior body’s midpoint.

TweezerTop

Bearish reversal at resistance: two candles sharing the same high.

TweezerBottom

Bullish reversal at support: two candles sharing the same low.

Doji

Indecision: open ≈ close (body ≤ 5 % of total range), wicks on both sides.

SpinningTop

Indecision: small body (≤ 30 % of range) with meaningful wicks on both sides.

BullishMarubozu

Bullish strength: nearly wick-free bullish candle (body ≥ 90 % of range).

BearishMarubozu

Bearish strength: nearly wick-free bearish candle (body ≥ 90 % of range).

Hammer

Potential bullish reversal: hammer shape (long lower wick) after a downtrend.

InvertedHammer

Potential bullish reversal: inverted-hammer shape (long upper wick) after a downtrend.

HangingMan

Potential bearish reversal: hammer shape (long lower wick) after an uptrend.

ShootingStar

Potential bearish reversal: inverted-hammer shape (long upper wick) after an uptrend.

Implementations

impl CandlePattern

pub fn sentiment(self) -> PatternSentiment

Returns the directional bias of this pattern.

Example

use finance_query::indicators::{CandlePattern, PatternSentiment};

assert_eq!(CandlePattern::Hammer.sentiment(), PatternSentiment::Bullish);
assert_eq!(CandlePattern::ShootingStar.sentiment(), PatternSentiment::Bearish);
assert_eq!(CandlePattern::Doji.sentiment(), PatternSentiment::Neutral);

Trait Implementations

impl Clone for CandlePattern

fn clone(&self) -> CandlePattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandlePattern

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CandlePattern

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CandlePattern

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CandlePattern

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CandlePattern

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CandlePattern

impl Eq for CandlePattern

impl StructuralPartialEq for CandlePattern