Struct datamaxi::models::CandleOptions

pub struct CandleOptions {
    pub market: Option<String>,
    pub interval: Option<String>,
    pub page: Option<i32>,
    pub limit: Option<i32>,
    pub from: Option<String>,
    pub to: Option<String>,
    pub sort: Option<String>,
}

Optional parameters for a candle request.

Fields

market: Option<String>

The market type (e.g., spot, futures).

interval: Option<String>

The interval for the candle data (e.g., 1m, 1h, 1d).

page: Option<i32>

The page number for the candle data.

limit: Option<i32>

The maximum number of items per page in the response.

from: Option<String>

The starting date & time for the candle data.

to: Option<String>

The ending date & time for the candle data.

sort: Option<String>

The sorting order for the candle data (e.g., “asc” or “desc”).

Implementations

impl CandleOptions

Provides a builder pattern for setting optional parameters for a candle request.

pub fn new() -> Self

Creates a new instance of CandleOptions with default values.

pub fn market(self, market: &str) -> Self

Sets the market for the candle query.

pub fn interval(self, interval: &str) -> Self

Sets the interval for the candle query.

pub fn page(self, page: i32) -> Self

Sets the page number for the candle query.

pub fn limit(self, limit: i32) -> Self

Sets the limit for the number of results returned.

pub fn from(self, from: &str) -> Self

Sets the starting date & time for the candle query.

pub fn to(self, to: &str) -> Self

Sets the ending date & time for the candle query.

pub fn sort(self, sort: &str) -> Self

Sets the sort order for the candle query (e.g., “asc” or “desc”).

Trait Implementations

impl Default for CandleOptions

fn default() -> Self

Returns the “default value” for a type.