Struct CandleQuery 

#[non_exhaustive]
pub struct CandleQuery {
    pub interval: CandleInterval,
    pub start: UnixMillis,
    pub end: Option<UnixMillis>,
}

Which candles to read: their width and the open times they span.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

interval: CandleInterval

The candles’ width.

start: UnixMillis

The earliest open time.

end: Option<UnixMillis>

The latest open time; now, when None.

Implementations

impl CandleQuery

pub fn new(interval: CandleInterval, start: UnixMillis) -> Self

Candles of interval from start to now.

pub fn end(self, end: UnixMillis) -> Self

Ends the span at end.

pub fn ensure_served( &self, served: &'static [CandleInterval], ) -> Result<(), UnservedInterval>

Checks that the query’s width is one of served, which a venue takes from its Candles::intervals. Call it before the first request, and convert the refusal with ?.

Trait Implementations

impl Clone for CandleQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CandleQuery

impl Debug for CandleQuery

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

Formats the value using the given formatter.

impl Eq for CandleQuery

impl PartialEq for CandleQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CandleQuery