Enum TimeSpec 

#[non_exhaustive]
pub enum TimeSpec {
    Range(Range),
    Period {
        start: DateTime<Utc>,
        end: DateTime<Utc>,
    },
}

Time specification for historical data requests.

This enum ensures that only one time specification method is used at a time, making range-vs-period exclusivity unrepresentable at compile time.

Direct enum construction can still build a Period whose start >= end. Use TimeSpec::period or TimeSpec::validate when constructing or accepting a standalone TimeSpec. HistoryRequestBuilder::build and TimeSpec deserialization also perform this validation.

Serializes as explicitly tagged JSON: { "kind": "range", "range": "6mo" } or { "kind": "period", "start": 1716595200000, "end": 1719187200000 }. Period timestamps use Unix milliseconds.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Range(Range)

Use a logical range preset (e.g., “1 month”, “1 year”).

Period

Use an explicit time period with start and end timestamps.

Fields

start: DateTime<Utc>

Start timestamp for the period.

end: DateTime<Utc>

End timestamp for the period.

Implementations

impl TimeSpec

pub const fn range(range: Range) -> TimeSpec

Build a logical range time specification.

pub fn period( start: DateTime<Utc>, end: DateTime<Utc>, ) -> Result<TimeSpec, MarketError>

Build a validated explicit period time specification.

Errors

Returns MarketError::InvalidPeriod when start >= end.

pub fn validate(&self) -> Result<(), MarketError>

Validate standalone TimeSpec invariants.

TimeSpec::Range is always valid. TimeSpec::Period must have start < end.

Errors

Returns MarketError::InvalidPeriod when a period has start >= end.

Trait Implementations

impl Clone for TimeSpec

fn clone(&self) -> TimeSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSpec

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

Formats the value using the given formatter.

impl Default for TimeSpec

fn default() -> TimeSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeSpec

fn deserialize<D>( deserializer: D, ) -> Result<TimeSpec, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TimeSpec

impl PartialEq for TimeSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TimeSpec

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeSpec