Struct Timeframe 

pub struct Timeframe {
    pub multiplier: u32,
    pub unit: TimeframeUnit,
}

The chart timeframe a script runs on, exposed as timeframe.*.

A multiplier plus a unit, e.g. { 3, Daily } → timeframe.period == "3D".

Fields

multiplier: u32

unit: TimeframeUnit

Implementations

impl Timeframe

pub fn as_minutes(&self) -> Option<u32>

The whole timeframe expressed in minutes. None for sub-minute and month periods, which have no whole-minute length.

pub fn from_millis(millis: i64) -> Option<Self>

The period covered by a gap of millis between two bars, or None if no whole unit divides it.

Months are never inferred: their length varies, so a monthly series has no single gap to recognise.

pub fn period(&self) -> String

The Pine period string, e.g. "3D", "60", "5S".

pub fn to_millis(&self) -> Option<i64>

pub fn is_seconds(&self) -> bool

pub fn is_minutes(&self) -> bool

pub fn is_daily(&self) -> bool

pub fn is_weekly(&self) -> bool

pub fn is_monthly(&self) -> bool

pub fn is_ticks(&self) -> bool

pub fn is_intraday(&self) -> bool

Intraday timeframes are seconds or minutes.

pub fn is_dwm(&self) -> bool

Day/week/month timeframes.

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

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for Timeframe

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

Parse a Pine period string ("5", "60", "1D", "30S", "1W").

type Err = TimeframeError

The associated error which can be returned from parsing.