Enum TimeFrame 

pub enum TimeFrame {
    M1,
    M5,
    M15,
    M30,
    H1,
    H4,
    D,
    W,
    MN,
}

Candle time frame, in the names of the broker.

The names are serialized as written (M1, H4, D, MN) and are exactly the list of the broker docs: M1 M5 M15 M30 H1 H4 D W MN. There is no ten-minute frame at BCS. The request models of this crate take the time frame as a string, so this enum is a convenience: TimeFrame::D.name() is the string to send.

Examples

use brokapi_bcs_protocol::models::enums::TimeFrame;

assert_eq!(serde_json::to_string(&TimeFrame::H1)?, "\"H1\"");
assert_eq!(TimeFrame::D.name(), "D");
// Names the broker does not know are refused when reading.
assert!(serde_json::from_str::<TimeFrame>("\"D1\"").is_err());

Variants

M1

One minute.

M5

Five minutes.

M15

Fifteen minutes.

M30

Thirty minutes.

H1

One hour.

H4

Four hours.

D

One day (D).

W

One week (W).

MN

One month.

Implementations

impl TimeFrame

pub fn name(self) -> &'static str

The name the broker uses, the one to put into a request.

Trait Implementations

impl Clone for TimeFrame

fn clone(&self) -> TimeFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimeFrame

impl Debug for TimeFrame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeFrame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TimeFrame

impl PartialEq for TimeFrame

fn eq(&self, other: &TimeFrame) -> 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 TimeFrame

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 TimeFrame