Enum kairos::timetype::TimeType

pub enum TimeType {
    Seconds(i64),
    Minutes(i64),
    Hours(i64),
    Days(i64),
    Months(i64),
    Years(i64),
    Moment(NaiveDateTime),
    Addition(Box<TimeType>, Box<TimeType>),
    Subtraction(Box<TimeType>, Box<TimeType>),
    EndOfYear(Box<TimeType>),
    EndOfMonth(Box<TimeType>),
    EndOfDay(Box<TimeType>),
    EndOfHour(Box<TimeType>),
    EndOfMinute(Box<TimeType>),
}

A Type of Time, currently based on chrono::NaiveDateTime

Variants

Seconds(i64)

Minutes(i64)

Hours(i64)

Days(i64)

Months(i64)

Years(i64)

Moment(NaiveDateTime)

Addition(Box<TimeType>, Box<TimeType>)

Subtraction(Box<TimeType>, Box<TimeType>)

EndOfYear(Box<TimeType>)

EndOfMonth(Box<TimeType>)

EndOfDay(Box<TimeType>)

EndOfHour(Box<TimeType>)

EndOfMinute(Box<TimeType>)

Implementations

impl TimeType

The TimeType type

Warning

If the TimeType is larger than the queried type (E.G. querying a “minutes” on a “month”), the following rules are applied:

• 60 Seconds make a Minute
• 60 Minutes make a Hour
• 24 Hours make a Day
• 7 Days make a Week
• 4 Weeks make a Month
• 12 Months make a Year

Whether these may be correct or not in the current year. The return value of the function is calculated appropriately. So, calling the get_seconds() function on 5 minutes returns 60 * 5.

If the TimeType is smaller than the queried type (E.G. querying a “month” on a “minutes”), zero is returned.

Also, if the TimeType is “5 weeks”, querying a month returns 1, as 5 weeks contain one full month.

pub fn today() -> TimeType

Alias for TimeType::moment(chrono::offset::Local::now().naive_local())

pub fn is_a_amount(&self) -> bool

pub fn is_moment(&self) -> bool

pub fn is_addition(&self) -> bool

pub fn is_subtraction(&self) -> bool

pub fn seconds(i: i64) -> TimeType

pub fn minutes(i: i64) -> TimeType

pub fn hours(i: i64) -> TimeType

pub fn days(i: i64) -> TimeType

pub fn weeks(i: i64) -> TimeType

Helper for TimeType::days(i * 7)

pub fn months(i: i64) -> TimeType

pub fn years(i: i64) -> TimeType

pub fn moment(ndt: NaiveDateTime) -> TimeType

pub fn end_of_year(self) -> TimeType

Calculate the end of the year based on the current TimeType

The end of a year is considered to be the last day of the year, not the last second.

Warning

If the current TimeType does not evaluate to a TimeType::Moment, calculating the end of the year will fail

pub fn end_of_month(self) -> TimeType

Calculate the end of the month based on the current TimeType

The end of a month is considered to be the last day of the month, not the last second.

Warning

If the current TimeType does not evaluate to a TimeType::Moment, calculating the end of the month will fail

pub fn end_of_day(self) -> TimeType

Calculate the end of the day based on the current TimeType

The end of a day is considered the last second of the day

Warning

If the current TimeType does not evaluate to a TimeType::Moment, calculating the end of the day will fail

pub fn end_of_hour(self) -> TimeType

Calculate the end of the hour based on the current TimeType

The end of a hour is considered the last second of a hour

Warning

If the current TimeType does not evaluate to a TimeType::Moment, calculating the end of the hour will fail

pub fn end_of_minute(self) -> TimeType

Calculate the end of the minute based on the current TimeType

The end of a minute is considered to be the last second of a minute

Warning

If the current TimeType does not evaluate to a TimeType::Moment, calculating the end of the minute will fail

pub fn get_seconds(&self) -> i64

Get the number of seconds, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_minutes(&self) -> i64

Get the number of minutes, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_hours(&self) -> i64

Get the number of hours, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_days(&self) -> i64

Get the number of days, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_months(&self) -> i64

Get the number of months, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_years(&self) -> i64

Get the number of years, if the TimeType is not a duration type, zero is returned

Warning

If the type is actually a smaller one (eg. calling get_minutes() on a seconds instance) the following rules are applied:

• A minute is 60 seconds
• A hour is 60 minutes
• A day is 24 hours
• A month is 30 days
• A year is 12 months

Which might not be always correct.

pub fn get_moment(&self) -> Option<&NaiveDateTime>

pub fn is_a(&self, d: Day) -> Result<bool>

Check whether a TimeType::Moment is a certain weekday. Returns an error if TimeType is not a TimeType::Moment.

pub fn is_in(&self, month: Month) -> Result<bool>

Check whether a TimeType::Moment is in a certain month. Returns an error if the TimeType is not a TimeType::Moment.

pub fn name(&self) -> &'static str

Get a string representation of the variant of the TimeType instance.

pub fn calculate(self) -> Result<TimeType>

Trait Implementations

impl Add for TimeType

type Output = TimeType

The resulting type after applying the + operator.

fn add(self, rhs: TimeType) -> Self::Output

Performs the + operation.

impl AddAssign for TimeType

fn add_assign(&mut self, rhs: TimeType)

Performs the += operation.

impl Clone for TimeType

fn clone(&self) -> TimeType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Daily for TimeType

fn daily(self, i: i64) -> Result<Iter>

impl Debug for TimeType

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

Formats the value using the given formatter.

impl Every for TimeType

fn every(self, inc: TT) -> Result<Iter>

impl Hourly for TimeType

fn hourly(self, i: i64) -> Result<Iter>

impl IntoTimeType for TimeType

fn into_timetype(self) -> Result<TimeType>

impl Minutely for TimeType

fn minutely(self, i: i64) -> Result<Iter>

impl Monthly for TimeType

fn monthly(self, i: i64) -> Result<Iter>

impl Ord for TimeType

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TimeType

fn eq(&self, other: &TimeType) -> 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 TimeType

fn partial_cmp(&self, other: &TimeType) -> 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 Sub for TimeType

type Output = TimeType

The resulting type after applying the - operator.

fn sub(self, rhs: TimeType) -> Self::Output

Performs the - operation.

impl SubAssign for TimeType

fn sub_assign(&mut self, rhs: TimeType)

Performs the -= operation.

impl Weekly for TimeType

fn weekly(self, i: i64) -> Result<Iter>

Conveniance function over Daily::daily( n * 7 )

impl Yearly for TimeType

fn yearly(self, i: i64) -> Result<Iter>

impl Eq for TimeType

impl StructuralPartialEq for TimeType