Struct CandleSpecification 

pub struct CandleSpecification {
    pub instrument: InstrumentName,
    pub granularity: CandlestickGranularity,
    pub price: Option<PricingComponent>,
}

An instrument name, a granularity, and a price component to get candlestick data for, e.g. EUR_USD:S10:BM.

Fields

instrument: InstrumentName

The instrument to get candles for.

granularity: CandlestickGranularity

The candlestick granularity.

price: Option<PricingComponent>

The price component(s); OANDA defaults to mid when omitted.

Implementations

impl CandleSpecification

pub fn new( instrument: impl Into<InstrumentName>, granularity: CandlestickGranularity, ) -> Self

A specification for the given instrument and granularity (mid price).

pub fn price(self, price: PricingComponent) -> Self

Selects the price component(s) for this specification.

Trait Implementations

impl Clone for CandleSpecification

fn clone(&self) -> CandleSpecification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandleSpecification

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

Formats the value using the given formatter.

impl Display for CandleSpecification

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

Formats the value using the given formatter.

impl Eq for CandleSpecification

impl Hash for CandleSpecification

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 CandleSpecification

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CandleSpecification