timex

v3.1.21

timex v3.1.21 Timex.Comparable protocol View Source

This protocol is used for comparing and diffing different date/time representations

Link to this section Summary

Types

comparable()
compare_result()
constants()
diff_result()
granularity()
t()

Functions

compare(a, b, granularity \\ :microseconds)

Compare two date or datetime types

diff(a, b, granularity \\ :microseconds)

Get the difference between two date or datetime types

Link to this section Types

Link to this type comparable() View Source 
comparable ::
  Date.t |
  DateTime.t |
  NaiveDateTime.t |
  Timex.Types.date |
  Timex.Types.datetime
Link to this type compare_result() View Source 
compare_result() :: -1 | 0 | 1 | {:error, term}
Link to this type constants() View Source 
constants() :: :epoch | :zero | :distant_past | :distant_future
Link to this type diff_result() View Source 
diff_result() :: Timex.Duration.t | integer | {:error, term}
Link to this type granularity() View Source 
granularity ::
  :years |
  :months |
  :weeks |
  :calendar_weeks |
  :days |
  :hours |
  :minutes |
  :seconds |
  :milliseconds |
  :microseconds |
  :duration

Link to this section Functions

Link to this function compare(a, b, granularity \\ :microseconds) View Source 
compare(comparable, comparable, granularity) :: compare_result

Compare two date or datetime types.

You can optionally specify a comparison granularity, any of the following:

  • :years
  • :months
  • :weeks
  • :calendar_weeks (weeks of the calendar as opposed to actual weeks in terms of days)
  • :days
  • :hours
  • :minutes
  • :seconds
  • :milliseconds
  • :microseconds (default)
  • :duration

and the dates will be compared with the cooresponding accuracy. The default granularity is :microseconds.

  • 0: when equal
  • -1: when the first date/time comes before the second
  • 1: when the first date/time comes after the second
  • {:error, reason}: when there was a problem comparing, perhaps due to a value being passed which is not a valid date/datetime
Link to this function diff(a, b, granularity \\ :microseconds) View Source 
diff(comparable, comparable, granularity) :: diff_result

Get the difference between two date or datetime types.

You can optionally specify a diff granularity, any of the following:

  • :years
  • :months
  • :calendar_weeks (weeks of the calendar as opposed to actual weeks in terms of days)
  • :weeks
  • :days
  • :hours
  • :minutes
  • :seconds
  • :milliseconds
  • :microseconds (default)
  • :duration

and the result will be an integer value of those units or a Duration struct. The diff value will be negative if a comes before b, and positive if a comes after b. This behaviour mirrors compare/3.