Struct yata::core::Candle

pub struct Candle {
    pub open: ValueType,
    pub high: ValueType,
    pub low: ValueType,
    pub close: ValueType,
    pub volume: ValueType,
}

Simple Candlestick structure for implementing OHLCV

Can be also used by an alias Candlestick

You may convert simple tuples of 4 or 5 float values into Candle:

use yata::prelude::Candle;
//               open  high  low  close
let my_candle = (3.0,  5.0,  2.0, 4.0  );
let converted: Candle = my_candle.into();
println!("{:?}", converted);

use yata::prelude::Candle;
//               open  high  low  close  volume
let my_candle = (3.0,  5.0,  2.0, 4.0  ,  50.0 );
let converted: Candle = my_candle.into();
println!("{:?}", converted);

Fields

open: ValueType

Open value of the candle

high: ValueType

High value of the candle

low: ValueType

Low value of the candle

close: ValueType

Close value of the candle

volume: ValueType

Volume value of the candle

Implementations

impl Candle

pub fn from<T: OHLCV + ?Sized>(src: &T) -> Self

Creates Candle from any another OHLCV-object.

Trait Implementations

impl<T: OHLCV> Add<T> for Candle

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl Clone for Candle

fn clone(&self) -> Candle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Candle

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

Formats the value using the given formatter.

impl Default for Candle

fn default() -> Candle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Candle

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

Deserialize this value from the given Serde deserializer.

impl From<&'_ (dyn OHLCV + 'static)> for Candle

fn from(src: &dyn OHLCV) -> Self

Converts to this type from the input type.

impl From<(f64, f64, f64, f64, f64)> for Candle

fn from(value: (ValueType, ValueType, ValueType, ValueType, ValueType)) -> Self

Converts to this type from the input type.

impl From<(f64, f64, f64, f64)> for Candle

fn from(value: (ValueType, ValueType, ValueType, ValueType)) -> Self

Converts to this type from the input type.

impl OHLCV for Candle

fn open(&self) -> ValueType

Should return an open value of the period

fn high(&self) -> ValueType

Should return an highest value of the period

fn low(&self) -> ValueType

Should return an lowest value of the period

fn close(&self) -> ValueType

Should return an close value of the candle

fn volume(&self) -> ValueType

Should return volume value for the period

fn tp(&self) -> ValueType

Calculates Typical price. It’s just a simple (High + Low + Close) / 3

fn hl2(&self) -> ValueType

Calculates arithmetic average of high and low values of the candle

fn ohlc4(&self) -> ValueType

Calculates arithmetic average of high, low, open and close values of the candle

fn clv(&self) -> ValueType

CLV = [(close - low) - (high - close)] / (high - low)

fn tr(&self, prev_candle: &dyn OHLCV) -> ValueType

Calculates True Range over last two candles

fn tr_close(&self, prev_close: ValueType) -> ValueType

Calculates True Range over last two candles using close price from the previous candle.

fn validate(&self) -> bool

Validates candle attributes

fn source(&self, source: Source) -> ValueType

Returns Source field value of the candle.

fn volumed_price(&self) -> ValueType

Volumed price

fn is_rising(&self) -> bool

Checks if candle is “rising”: it’s close value greater than open value

fn is_falling(&self) -> bool

Checks if candle is “falling”: it’s close value smaller than open value

impl PartialEq<Candle> for Candle

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Candle> for Candle

fn partial_cmp(&self, other: &Candle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Candle

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 Candle

impl Eq for Candle