Struct TimeframeVisibility 

pub struct TimeframeVisibility {
    pub show_on_all: bool,
    pub visible_timeframes: HashSet<String>,
    pub ranges: BTreeMap<TimeframeUnit, RangeInclusive<u64>>,
}

The intervals a drawing shows on.

While show_on_all is set, a drawing shows on every interval. Otherwise it shows on the intervals named in visible_timeframes and on those whose unit has a range in ranges holding their value. An interval’s unit and value are those of its label, as Timeframe::as_str writes it: 90min is 90 minutes, and a 24 hour interval, labelled 1D, is 1 day.

Fields

show_on_all: bool

Show on every interval.

visible_timeframes: HashSet<String>

Interval labels the drawing shows on, matched exactly.

ranges: BTreeMap<TimeframeUnit, RangeInclusive<u64>>

Values of each unit the drawing shows on, both ends included, such as 1 to 4 hours for 1h, 2h, 3h and 4h. A range whose start is after its end holds no value.

Implementations

impl TimeframeVisibility

pub fn all() -> Self

Create visibility for all timeframes (default)

pub fn specific(timeframes: &[&str]) -> Self

Create visibility for specific timeframes only

pub fn is_visible_on(&self, timeframe: &str) -> bool

Check if visible on the interval labelled timeframe

pub fn range(&self, unit: TimeframeUnit) -> Option<RangeInclusive<u64>>

The values of unit the drawing shows on: its range, widened to cover the labels of that unit in visible_timeframes. None when neither names the unit.

pub fn set_range( &mut self, unit: TimeframeUnit, range: Option<RangeInclusive<u64>>, )

Show the drawing on range of unit, or on no interval of that unit for None, in place of that unit’s labels in visible_timeframes. A range turns show_on_all off.

pub fn add_timeframe(&mut self, timeframe: &str)

Add a timeframe to visibility

pub fn remove_timeframe(&mut self, timeframe: &str)

Remove a timeframe from visibility

Trait Implementations

impl Clone for TimeframeVisibility

fn clone(&self) -> TimeframeVisibility

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeframeVisibility

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

Formats the value using the given formatter.

impl Default for TimeframeVisibility

fn default() -> TimeframeVisibility

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeframeVisibility

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TimeframeVisibility

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TimeframeVisibility

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 TimeframeVisibility