Enum Timeframe 

pub enum Timeframe {
    Seconds(u64),
    Minutes(u64),
    Hours(u64),
}

Supported bar timeframes.

Variants

Seconds(u64)

Bar duration measured in seconds.

Minutes(u64)

Bar duration measured in minutes.

Hours(u64)

Bar duration measured in hours.

Implementations

impl Timeframe

pub fn duration_ms(self) -> u64

Duration in milliseconds.

pub fn bar_start_ms(self, ts_ms: u64) -> u64

Bar start timestamp for a given ms timestamp.

pub fn from_duration_ms(ms: u64) -> Option<Timeframe>

Construct a Timeframe from a millisecond duration.

Prefers the largest canonical unit that divides evenly: hours > minutes > seconds. Returns None if ms is zero or not a whole number of seconds.

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

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

Formats the value using the given formatter.

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

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

Parse a timeframe string such as "1s", "5m", or "2h".

The format is a positive integer followed by a unit suffix:

• s — seconds (e.g. "30s")
• m — minutes (e.g. "5m")
• h — hours (e.g. "1h")

Errors

Returns StreamError::ConfigError if the string is empty, has an unknown suffix, or if the numeric part is zero or cannot be parsed.

type Err = StreamError

The associated error which can be returned from parsing.

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

fn cmp(&self, other: &Self) -> Ordering

Compares timeframes by their duration in milliseconds.

For example: Seconds(30) < Minutes(1) < Hours(1).

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Timeframe

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Timeframe

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= 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 Copy for Timeframe

impl Eq for Timeframe

impl StructuralPartialEq for Timeframe