Struct chrono_elapsed::Elapsed

pub struct Elapsed {
    pub duration: Duration,
    pub passed: bool,
    pub cache: HashMap<TimeFrame, (Cow<'static, str>, i64)>,
    // some fields omitted
}

Provides a context-aware DateTime object; a given DateTime is made aware in the context of the current DateTime (or in the context of a given DateTime, see new_with_context.)

Allows you to easily obtain information such as datetime is due in 42 minutes and 30 seconds, datetime is overdue by 3 days and 2 hours, or when given context, time between x and y is 42 years and 9 months.

Aliased as DueDateTime out of the box in case that makes more sense in your context.

Fields

duration: Duration

Also known as the diff, difference in time between a given DateTime and the DateTime used for context.

passed: bool

If the date has already passed, or elapsed, it’s no longer due so we can skip some processing, and format a more meaningful message on display.

cache: HashMap<TimeFrame, (Cow<'static, str>, i64)>

A cache of diff values. Key being the sec/min/hour/day, etc. identifier. Value being a tuple of the diff value as a string in pos 0, and numeric value in pos 1.

Implementations

impl Elapsed

pub fn new(datetime: DateTime<Local>) -> Self

Construct a new object.

pub fn new_from_date(date: Date<Local>) -> Self

Construct a new object from a Date rather than DateTime.

pub fn new_then_localize(datetime: DateTime<Utc>) -> Self

Construct a new object and then add Local timezone.

pub fn new_from_date_then_localize(date: Date<Utc>) -> Self

Construct a new object from a Date then add Local timezone.

pub fn new_with_context(
    datetime: DateTime<Local>,
    context: DateTime<Local>
) -> Self

Construct a new object with a custom context, rather than the default now.

pub fn new_from_date_with_context(
    date: Date<Local>,
    context: Date<Local>
) -> Self

Construct a new object from a Date with a custom context.

pub fn set_datetime_context(
    &mut self,
    datetime_context: DateTime<Local>
) -> &mut Self

Set the Elapsed’s datetime_context. Will clear cached diff values.

pub fn set_datetime(&mut self, datetime: DateTime<Local>) -> &mut Self

Set the Elapsed’s datetime. Will clear cached diff values.

pub fn set_date(&mut self, date: Date<Local>)

Set the Elapsed’s date. Will clear cached diff values.

pub fn process(&mut self, clear_cache: bool)

Populate cache with contextually aware TimeFrames. Discards “irrelevant” time frames, for example if date is due in more than a year, we’ll only store 1y 6m as opposed to 1y 6m 2w 4d.

pub fn cache_insert(&mut self, k: TimeFrame, v: i64)

Helper function to insert a value for a TimeFrame into the cache.

pub fn num_years(&self) -> i64

Get number of years.

pub fn years(&mut self) -> (Cow<'static, str>, i64)

Get years between DateTime and DateTime given for context as elapsed style tuple.

pub fn years_and(&mut self) -> &mut Self

Get years between DateTime and DateTime given for context. Can be chained to string together multiple values of your choosing.

let date = self.years_and().months_and().weeks();
println!("{}", date);
let silly_date = self.years_and().seconds();
println!("{}", silly_date);

Results in 1y 6m 2w the first time, or something silly the second time..

pub fn num_months(&self) -> i64

Get number of months.

pub fn months(&mut self) -> (Cow<'static, str>, i64)

Get months between DateTime and DateTime given for context as elapsed style tuple.

pub fn weeks(&mut self) -> (Cow<'static, str>, i64)

Get weeks between DateTime and DateTime given for context as elapsed style tuple.

Chrono provides a method to get numeric value alone, which is exposed by Elapsed struct duration field.

pub fn days(&mut self) -> (Cow<'static, str>, i64)

Get days between DateTime and DateTime given for context as elapsed style tuple.

Chrono provides a method to get numeric value alone, which is exposed by Elapsed struct duration field.

pub fn hours(&mut self) -> (Cow<'static, str>, i64)

Get hours between DateTime and DateTime given for context as elapsed style tuple.

Chrono provides a method to get numeric value alone, which is exposed by Elapsed struct duration field.

pub fn minutes(&mut self) -> (Cow<'static, str>, i64)

Get minutes between DateTime and DateTime given for context as elapsed style tuple.

Chrono provides a method to get numeric value alone, which is exposed by Elapsed struct duration field.

pub fn seconds(&mut self) -> (Cow<'static, str>, i64)

Get seconds between DateTime and DateTime given for context as elapsed style tuple.

Chrono provides a method to get numeric value alone, which is exposed by Elapsed struct duration field.

pub fn through_til(&mut self, tf: &TimeFrame) -> &mut Self

This fn is intended to be used similarly to chaining, like so:

let date = self.seconds_and().through_til(&TimeFrame::Months);
println!("{}", date);

Resulting in seconds, minutes, hours, days, weeks and months being set in cache, and then subsequently printed as (in) 3y 2w 4d 12hr 32min 42sec (ago).

pub fn collect(&self) -> HashMap<TimeFrame, (Cow<'static, str>, i64)>

Create a clone of our cache containing the values at time of collection.

Trait Implementations

impl Clone for Elapsed

fn clone(&self) -> Elapsed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Elapsed

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

Formats the value using the given formatter.

impl Display for Elapsed

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

Formats the value using the given formatter.

impl From<Date<Local>> for Elapsed

fn from(date: Date<Local>) -> Self

Construct from localised Date.

impl From<Date<Utc>> for Elapsed

fn from(date: Date<Utc>) -> Self

Construct from UTC Date.

impl From<DateTime<Local>> for Elapsed

fn from(datetime: DateTime<Local>) -> Self

Construct from localised DateTime.

impl From<DateTime<Utc>> for Elapsed

fn from(datetime: DateTime<Utc>) -> Self

Construct from UTC DateTime.