kumomta/docs/reference/kumo.time/Time.md

Time Object

{{since('dev')}}

The Time object represents a date and time. It internally stores the time as UTC, even if it was produced by parsing time from some other time zone.

Metamethods

The following metamethods are implemented on Time objects:

• __tostring - returns a human readable representation of the time like 1970-01-01 00:00:01 UTC.
• __eq - compares two Time objects for equality
• + - addition. You may add a TimeDelta to a Time to produce a new Time offset by the added delta.
• - - subtraction:
  • You may subtract a TimeDelta from a Time to produce a new Time offset by the added delta.
  • You may subtract a Time from a Time to produce a TimeDelta representing the difference between the two times

Fields

The following fields expose various properties of the underlying Time object. Fields are accessed using dot notation, like time.rfc2822.

• year - the year number portion of the ISO 8601 calendar date.
• month - the month number of the calendar date, starting with 1 for January.
• day - the day of the month of the calendar date, starting from 1.
• hour - the hour number, from 0 to 23.
• minute - the minute number, from 0 to 59.
• second - the second number, from 0 to 59.
• unix_timestamp - the number of non-leap seconds since January 1, 1970 0:00:00 UTC (aka "UNIX timestamp").
• unix_timestamp_millis - the number of non-leap milliseconds since January 1, 1970 0:00:00 UTC.
• rfc2822 - the time formatted according to RFC 2822
• rfc3339 - the time formatted according to RFC 3339
• elapsed - the TimeDelta corresponding to the difference between this Time object and the time at which the elapsed field is evaluated.

Methods

The following methods are implemented on Time objects. Methods are accessed using colon notation, like time:format().

Time:format

local string = time:format '%H:%M:%S'

Formats the time object using the strftime syntax supported by the Rust chrono crate.

Parsing of the format string is lenient, but it is still possible that for invalid format strings to raise errors.