Struct exc_types::Period

pub struct Period {
    pub offset: UtcOffset,
    pub kind: PeriodKind,
}

Period mode (A tumbling window).

Fields

offset: UtcOffset

UTC offset.

kind: PeriodKind

Period kind.

Implementations

impl Period

pub fn zero() -> Period

Zero period.

Directly compare the two timestamp.

pub fn year(offset: UtcOffset) -> Period

A year.

pub fn month(offset: UtcOffset) -> Period

A Month.

pub fn day(offset: UtcOffset) -> Period

A Day.

pub fn weeks(offset: UtcOffset, weeks: u32) -> Period

Weeks.

pub fn days(offset: UtcOffset, days: u32) -> Period

Days.

pub fn hours(offset: UtcOffset, hours: u32) -> Period

Hours.

pub fn minutes(offset: UtcOffset, minutes: u32) -> Period

Minutes

pub fn seconds(offset: UtcOffset, seconds: u64) -> Period

Seconds

pub fn secs(seconds: u64) -> Period

Seconds.

pub fn to_std_duration(&self) -> Option<Duration>

Convert period to Duration.

Return None if period is a year or a month.

pub fn to_duration(&self) -> Option<Duration>

Convert period to time::Duration.

Return None if period is a year or a month.

pub fn utc_offset(&self) -> UtcOffset

Get the utc offset of this period.

pub fn kind(&self) -> PeriodKind

Get period kind.

pub fn to_offset(&self, offset: UtcOffset) -> Period

Change the utc offset.

Example

use indicator::Period;
use time::macros::offset;

let period = Period::day(offset!(+0));
assert_eq!(period.to_offset(offset!(+8)), Period::day(offset!(+8)));

Trait Implementations

impl Clone for Period

fn clone(&self) -> Period

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Period

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

Formats the value using the given formatter.

impl Display for Period

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

Formats the value using the given formatter.

impl Hash for Period

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Period

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Period

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TumblingWindow for Period

fn same_window(&self, lhs: &Tick, rhs: &Tick) -> bool

Is in the same window.

impl Copy for Period

impl Eq for Period

impl StructuralPartialEq for Period