Enum Timeframe 

#[non_exhaustive]
pub enum Timeframe {
    Ms100,
    Ms250,
    Ms500,
    Sec1,
    Sec2,
    Sec5,
    Sec10,
    Sec30,
    Min1,
    Min5,
    Min15,
    Min30,
    Hour1,
    Hour4,
    Day1,
    Week1,
    Month1,
    Custom(NonZeroU64),
    Ticks(NonZeroU64),
    Volume(NonZeroU64),
    Range(NonZeroU64),
    Delta(NonZeroU64),
    Weeks(NonZeroU32),
    Months(NonZeroU32),
}

Timeframe for bar aggregation.

Time variants represent a fixed or calendar interval over which OHLCV data is aggregated into a single Bar. The default timeframe is Min1.

Timeframes are divided into tiers:

Tier	Variants
Tick count	Ticks(count) – a nonzero number of executions
Volume	Volume(units) – exact traded volume
Range	Range(ticks) – price range in instrument ticks
Delta	Delta(units) – absolute buy minus sell volume
Millisecond	Ms100, Ms250, Ms500
Second	Sec1 .. Sec30
Minute	Min1, Min5, Min15, Min30
Hourly	Hour1, Hour4
Daily+	Day1, Week1, Month1, Weeks(count), Months(count)
Custom	Custom(seconds) – any user-defined interval

Example

use egui_charts::model::Timeframe;

let tf = Timeframe::Hour4;
assert_eq!(tf.duration_ms(), 14_400_000);
assert_eq!(tf.to_string(), "4h");

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.

Ms100

100-millisecond bars (HFT).

Ms250

250-millisecond bars (HFT).

Ms500

500-millisecond bars (HFT).

Sec1

1-second bars.

Sec2

2-second bars.

Sec5

5-second bars.

Sec10

10-second bars.

Sec30

30-second bars.

Min1

1-minute bars (default).

Min5

5-minute bars.

Min15

15-minute bars.

Min30

30-minute bars.

Hour1

1-hour bars.

Hour4

4-hour bars.

Day1

Daily bars.

Week1

Weekly bars.

Month1

Monthly bars (approximated as 30 days for duration calculations).

Custom(NonZeroU64)

Custom timeframe defined in seconds. Allows user-defined intervals (e.g., 45s, 3min, 2h). The interval is never zero.

Ticks(NonZeroU64)

One bar per nonzero number of accepted trades, starting at subscription or replay start.

Volume(NonZeroU64)

Exact traded volume per bar, in whole units. A fill spanning bars is split by size.

Range(NonZeroU64)

Price range in instrument ticks. Closes on the first real fill reaching the range; skipped prices can overshoot it. No synthetic executions are inserted.

Delta(NonZeroU64)

Absolute buy minus sell volume per bar, in whole units. Fills split at the threshold; unknown sides contribute volume but no delta.

Weeks(NonZeroU32)

Calendar weeks, aligned to Monday 1970-01-05 in the clock’s timezone.

Months(NonZeroU32)

Calendar months, aligned to January 1970 in the clock’s timezone. Three, six and twelve months start on calendar quarters, half-years and years.

Implementations

impl Timeframe

pub fn as_str(&self) -> Cow<'static, str>

Returns the canonical string label for this timeframe (e.g. "1min", "4h", "1D").

pub fn is_trade_based(self) -> bool

Whether bars close on executions rather than a time boundary.

pub fn all() -> Vec<Timeframe>

Returns the preset time intervals in ascending duration order. Trade-based intervals are excluded.

pub fn duration_ms(&self) -> i64

Duration in milliseconds, saturating at i64::MAX for huge custom timeframes. Calendar months use an approximate 30 days each; use super::BarClock for boundaries. Trade-based intervals have no time duration and return zero; do not use them to step time.

pub fn duration(&self) -> Duration

Duration as a chrono value; zero for trade-based intervals.

pub fn is_custom(&self) -> bool

Returns true if this is a user-defined custom timeframe

pub fn from_resolution(resolution: &str) -> Option<Self>

Convert a resolution string to Timeframe

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 Default for Timeframe

fn default() -> Self

Default timeframe is 1 minute

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 Display for Timeframe

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

Formats the value using the given formatter.

impl Eq for Timeframe

impl From<Timeframe> for BarClock

fn from(timeframe: Timeframe) -> Self

Converts to this type from the input type.

impl FromStr for Timeframe

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Timeframe

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 Timeframe

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

Equality operator ==.

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

Inequality operator !=.

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