Elixir

v1.4.4

Elixir

Elixir v1.4.4 Calendar behaviour View Source

This module defines the responsibilities for working with calendars, dates, times and datetimes in Elixir.

Currently it defines types and the minimal implementation for a calendar behaviour in Elixir. The goal of the Calendar features in Elixir is to provide a base for interoperability instead of full-featured datetime API.

For the actual date, time and datetime structures, see Date, Time, NaiveDateTime and DateTime.

Note the year, month, day, etc designations are overspecified (i.e. an integer instead of 1..12 for months) because different calendars may have a different number of days per month, months per year and so on.

Link to this section Summary

Types

calendar()

A calendar implementation

date()

Any map/struct that contains the date fields

datetime()

Any map/struct that contains the datetime fields

day()
hour()
microsecond()

Microseconds with stored precision

minute()
month()
naive_datetime()

Any map/struct that contains the naive_datetime fields

second()

From 0 to 60 to account for leap seconds

std_offset()

The time zone standard offset in seconds (not zero in summer times)

time()

Any map/struct that contains the time fields

time_zone()

The time zone ID according to the IANA tz database (e.g. Europe/Zurich)

utc_offset()

The time zone UTC offset in seconds

year()
zone_abbr()

The time zone abbreviation (e.g. CET or CEST or BST etc.)

Callbacks

date_to_string(year, month, day)

Converts the date into a string according to the calendar

datetime_to_string(year, month, day, hour, minute, second, microsecond, time_zone, zone_abbr, utc_offset, std_offset)

Coverts the date time (with time zone) into a string according to the calendar

day_of_week(year, month, day)

Calculates the day of the week from the given year, month, and day

days_in_month(year, month)

Returns how many days there are in the given year-month

leap_year?(year)

Returns true if the given year is a leap year

naive_datetime_to_string(year, month, day, hour, minute, second, microsecond)

Converts the date time (without time zone) into a string according to the calendar

Link to this section Types

Link to this type calendar() View Source 
calendar() :: module

A calendar implementation

Link to this type date() View Source 
date() :: %{optional(any) => any, :calendar => calendar, :year => year, :month => month, :day => day}

Any map/struct that contains the date fields

Link to this type datetime() View Source 
datetime() :: %{optional(any) => any, :calendar => calendar, :year => year, :month => month, :day => day, :hour => hour, :minute => minute, :second => second, :microsecond => microsecond, :time_zone => time_zone, :zone_abbr => zone_abbr, :utc_offset => utc_offset, :std_offset => std_offset}

Any map/struct that contains the datetime fields

Link to this type day() View Source 
day() :: integer
Link to this type hour() View Source 
hour() :: 0..23
Link to this type microsecond() View Source 
microsecond() :: {0..999999, 0..6}

Microseconds with stored precision.

The precision represents the number of digits that must be used when representing the microseconds to external format. If the precision is 0, it means microseconds must be skipped.

Link to this type minute() View Source 
minute() :: 0..59
Link to this type month() View Source 
month() :: integer
Link to this type naive_datetime() View Source 
naive_datetime() :: %{optional(any) => any, :calendar => calendar, :year => year, :month => month, :day => day, :hour => hour, :minute => minute, :second => second, :microsecond => microsecond}

Any map/struct that contains the naive_datetime fields

Link to this type second() View Source 
second() :: 0..60

From 0 to 60 to account for leap seconds

Link to this type std_offset() View Source 
std_offset() :: integer

The time zone standard offset in seconds (not zero in summer times)

Link to this type time() View Source 
time() :: %{optional(any) => any, :hour => hour, :minute => minute, :second => second, :microsecond => microsecond}

Any map/struct that contains the time fields

Link to this type time_zone() View Source 
time_zone() :: String.t

The time zone ID according to the IANA tz database (e.g. Europe/Zurich)

Link to this type utc_offset() View Source 
utc_offset() :: integer

The time zone UTC offset in seconds

Link to this type year() View Source 
year() :: integer
Link to this type zone_abbr() View Source 
zone_abbr() :: String.t

The time zone abbreviation (e.g. CET or CEST or BST etc.)

Link to this section Callbacks

Link to this callback date_to_string(year, month, day) View Source 
date_to_string(year, month, day) :: String.t

Converts the date into a string according to the calendar.

Link to this callback datetime_to_string(year, month, day, hour, minute, second, microsecond, time_zone, zone_abbr, utc_offset, std_offset) View Source 
datetime_to_string(year, month, day, hour, minute, second, microsecond, time_zone, zone_abbr, utc_offset, std_offset) :: String.t

Coverts the date time (with time zone) into a string according to the calendar.

Link to this callback day_of_week(year, month, day) View Source 
day_of_week(year, month, day) :: non_neg_integer

Calculates the day of the week from the given year, month, and day.

Link to this callback days_in_month(year, month) View Source 
days_in_month(year, month) :: day

Returns how many days there are in the given year-month.

Link to this callback leap_year?(year) View Source 
leap_year?(year) :: boolean

Returns true if the given year is a leap year.

A leap year is a year of a longer length than normal. The exact meaning is up to the calendar. A calendar must return false if it does not support the concept of leap years.

Link to this callback naive_datetime_to_string(year, month, day, hour, minute, second, microsecond) View Source 
naive_datetime_to_string(year, month, day, hour, minute, second, microsecond) :: String.t

Converts the date time (without time zone) into a string according to the calendar.