Календарь поведение

Этот модуль определяет обязанности по работе с календарями, датами, временем и датами и временем в Elixir.

В настоящее время он определяет типы и минимальную реализацию поведения календаря в Elixir. Цель функций календаря в Elixir — обеспечить базу для межсовместимости вместо полнофункционального API работы с датой и временем.

Для фактических структур даты, времени и даты и времени см. Date, Time, NaiveDateTime и DateTime.

Обратите внимание, что обозначения года, месяца, дня и т. д. переопределены (т. е. целое число вместо 1..12 для месяцев), потому что разные календари могут иметь разное количество дней в месяце, месяцев в году и т. д.

Обзор

Типы

calendar(): Реализация календаря
date(): Любой map/struct, содержащий поля даты
datetime(): Любой map/struct, содержащий поля даты и времени
day()
day_fraction(): Внутренний формат времени используется при преобразовании между календарями.
day_of_week()
era()
hour()
iso_days(): Внутренний формат даты, используемый при преобразовании между календарями.
microsecond(): Микросекунды с сохранённой точностью.
minute()
month()
naive_datetime(): Любой map/struct, содержащий поля naive_datetime
second()
std_offset(): Стандартное смещение часового пояса в секундах (не ноль в летнее время)
time(): Любой map/struct, содержащий поля времени
time_zone(): Идентификатор часового пояса в соответствии с базой данных часовых поясов IANA (например, Europe/Zurich)
time_zone_database(): Указывает базу данных часовых поясов для операций с календарем.
utc_offset(): Смещение часового пояса по UTC в секундах
week()
year()
zone_abbr(): Аббревиатура часового пояса (например, CET или CEST или BST и т. д.)

Функции

compatible_calendars?(calendar, calendar): Возвращает true, если у двух календарей одинаковый момент начала нового дня, false, в противном случае.
get_time_zone_database(): Получает текущую базу данных часовых поясов.
put_time_zone_database(database): Устанавливает текущую базу данных часовых поясов.
truncate(microsecond_tuple, atom): Возвращает кортеж микросекунд, усечённый до заданной точности (:microsecond, :millisecond или :second).

Обратные вызовы

date_to_string(year, month, day): Преобразует дату в строку в соответствии с календарём.
datetime_to_string(year, month, day, hour, minute, second, microsecond, time_zone, zone_abbr, utc_offset, std_offset): Преобразует datetime (с часовым поясом) в строку в соответствии с календарём.
day_of_era(year, month, day): Вычисляет день и эру из заданных year, month, и day.
day_of_week(year, month, day): Вычисляет день недели из заданных year, month, и day.
day_of_year(year, month, day): Вычисляет день года из заданных year, month, и day.
day_rollover_relative_to_midnight_utc(): Определяет момент перехода для данного календаря.
days_in_month(year, month): Возвращает количество дней в заданном месяце года.
leap_year?(year): Возвращает true, если заданный год високосный.
months_in_year(year): Возвращает количество месяцев в заданном году.
naive_datetime_from_iso_days(iso_days): Преобразует iso_days/0 в формат даты и времени календаря.
naive_datetime_to_iso_days(year, month, day, hour, minute, second, microsecond): Преобразует заданную дату и время (без часового пояса) в формат iso_days/0.
naive_datetime_to_string(year, month, day, hour, minute, second, microsecond): Преобразует дату и время (без часового пояса) в строку в соответствии с календарём.
quarter_of_year(year, month, day): Вычисляет квартал года из заданных year, month, и day.
time_from_day_fraction(day_fraction): Преобразует day_fraction/0 в формат времени календаря.
time_to_day_fraction(hour, minute, second, microsecond): Преобразует заданное время в формат day_fraction/0.
time_to_string(hour, minute, second, microsecond): Преобразует время в строку в соответствии с календарём.
valid_date?(year, month, day): Должно возвращать true, если заданная дата описывает корректную дату в календаре.
valid_time?(hour, minute, second, microsecond): Должно возвращать true, если заданное время описывает корректное время в календаре.
year_of_era(year): Вычисляет год и эру из заданного year.

Типы

calendar()

calendar() :: module()

Реализация календаря

date()

date() :: %{
  optional(any()) => any(),
  :calendar => calendar(),
  :year => year(),
  :month => month(),
  :day => day()
}

Любой map/struct, содержащий поля даты

datetime()

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()
}

Любой map/struct, содержащий поля даты и времени

day()

day() :: pos_integer()

day_fraction()

day_fraction() ::
  {parts_in_day :: non_neg_integer(), parts_per_day :: pos_integer()}

Внутренний формат времени используется при преобразовании между календарями.

Он представляет время как долю дня (начиная с полуночи). parts_in_day указывает, сколько дня уже прошло, а parts_per_day указывает, сколько частей помещается в день.

day_of_week()

day_of_week() :: non_neg_integer()

era()

era() :: non_neg_integer()

hour()

hour() :: non_neg_integer()

iso_days()

iso_days() :: {days :: integer(), day_fraction()}

Внутренний формат даты, используемый при преобразовании между календарями.

Это количество дней, включая дробную часть, прошедших с 0000-01-01+00:00T00:00.000000 в формате ISO 8601 (также известное как полночь 1 января до н. э. 1 пролептического григорианского календаря).

microsecond()

microsecond() :: {0..999_999, 0..6}

Микросекунды с сохранённой точностью.

Точность представляет количество цифр, которые должны быть использованы при представлении микросекунд во внешнем формате. Если точность равна 0, это означает, что микросекунды должны быть пропущены.

minute()

minute() :: non_neg_integer()

month()

month() :: pos_integer()

naive_datetime()

naive_datetime() :: %{
  optional(any()) => any(),
  :calendar => calendar(),
  :year => year(),
  :month => month(),
  :day => day(),
  :hour => hour(),
  :minute => minute(),
  :second => second(),
  :microsecond => microsecond()
}

Любой массив/структура, содержащая поля naive_datetime

second()

second() :: non_neg_integer()

std_offset()

std_offset() :: integer()

Стандартное смещение часового пояса во секундах (не ноль в летнее время)

time()

time() :: %{
  optional(any()) => any(),
  :hour => hour(),
  :minute => minute(),
  :second => second(),
  :microsecond => microsecond()
}

Любой массив/структура, содержащая поля времени

time_zone()

time_zone() :: String.t()

Идентификатор часового пояса согласно базе данных IANA tz (например, Europe/Zurich)

time_zone_database()

time_zone_database() :: module()

Указывает базу данных часовых поясов для операций с календарём.

Многие функции в модуле DateTime требуют базу данных часовых поясов. По умолчанию используется база данных часовых поясов, возвращаемая функцией Calendar.get_time_zone_database/0, которая по умолчанию устанавливает Calendar.UTCOnlyTimeZoneDatabase, обрабатывающую только даты и время "Etc/UTC" и возвращающую {:error, :utc_only_time_zone_database} для любого другого часового пояса.

Другие базы данных часовых поясов (включая предоставляемые пакетами) могут быть настроены по умолчанию либо через конфигурацию:

config :elixir, :time_zone_database, CustomTimeZoneDatabase

либо вызвав функцию Calendar.put_time_zone_database/1.

Дополнительную информацию о пользовательских базах данных часовых поясов см. в Calendar.TimeZoneDatabase.

utc_offset()

utc_offset() :: integer()

Смещение часового пояса относительно UTC в секундах

week()

week() :: pos_integer()

year()

year() :: integer()

zone_abbr()

zone_abbr() :: String.t()

Аббревиатура часового пояса (например, CET или CEST или BST и т. д.)

Функции

compatible_calendars?(calendar, calendar)

(since 1.5.0)

compatible_calendars?(Calendar.calendar(), Calendar.calendar()) :: boolean()

Возвращает true, если у двух календарей одинаковый момент начала нового дня, false, в противном случае.

Если два календаря не совместимы, мы можем преобразовывать только даты и время между ними. Если они совместимы, это означает, что мы также можем преобразовывать даты и неявные даты и время между ними.

get_time_zone_database()

(since 1.8.0)

get_time_zone_database() :: time_zone_database()

Получает текущую базу данных часовых поясов.

put_time_zone_database(database)

(since 1.8.0)

put_time_zone_database(time_zone_database()) :: :ok

Устанавливает текущую базу данных часовых поясов.

truncate(microsecond_tuple, atom)

(since 1.6.0)

truncate(Calendar.microsecond(), :microsecond | :millisecond | :second) ::
  Calendar.microsecond()

Возвращает кортеж микросекунд, усечённый до заданной точности (:microsecond, :millisecond или :second).

Обработчики

date_to_string(year, month, day)

date_to_string(year(), month(), day()) :: String.t()

Преобразует дату в строку в соответствии с календарём.

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

datetime_to_string(
  year(),
  month(),
  day(),
  hour(),
  minute(),
  second(),
  microsecond(),
  time_zone(),
  zone_abbr(),
  utc_offset(),
  std_offset()
) :: String.t()

Преобразует дату и время (с часовым поясом) в строку в соответствии с календарём.

day_of_era(year, month, day)

day_of_era(year(), month(), day()) :: {non_neg_integer(), era()}

Вычисляет день и эру из заданного year, month, и day.

day_of_week(year, month, day)

day_of_week(year(), month(), day()) :: day_of_week()

Вычисляет день недели из заданного year, month, и day.

day_of_year(year, month, day)

day_of_year(year(), month(), day()) :: non_neg_integer()

Вычисляет день года из заданного year, month, и day.

day_rollover_relative_to_midnight_utc()

day_rollover_relative_to_midnight_utc() :: day_fraction()

Определяет момент перехода на следующий день для данного календаря.

Это момент, в вашем календаре, когда текущий день заканчивается, и начинается следующий.

Результат этой функции используется для проверки, переходят ли два календаря на новый день в одно и то же время. Если нет, мы можем преобразовать только даты и время между ними. Если да, это означает, что мы также можем преобразовывать даты и неявные даты и время между ними.

Эта дробь дня должна быть представлена в максимально упрощённой форме для ускорения сравнений.

Примеры

Если в вашем календаре новый день начинается в полночь, верните {0, 1}.
Если в вашем календаре новый день начинается на рассвете, верните {1, 4}.
Если в вашем календаре новый день начинается в полдень, верните {1, 2}.
Если в вашем календаре новый день начинается на закате, верните {3, 4}.

days_in_month(year, month)

days_in_month(year(), month()) :: day()

Возвращает количество дней в данном месяце года.

leap_year?(year)

leap_year?(year()) :: boolean()

Возвращает true, если данный год високосный.

Високосный год — это год с большей длиной, чем обычно. Точное значение зависит от календаря. Календарь должен возвращать false, если он не поддерживает концепцию високосных годов.

months_in_year(year)

months_in_year(year()) :: month()

Возвращает количество месяцев в данном году.

naive_datetime_from_iso_days(iso_days)

naive_datetime_from_iso_days(iso_days()) ::
  {year(), month(), day(), hour(), minute(), second(), microsecond()}

Преобразует iso_days/0 в формат даты и времени календаря.

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

naive_datetime_to_iso_days(
  year(),
  month(),
  day(),
  hour(),
  minute(),
  second(),
  microsecond()
) :: iso_days()

Преобразует заданное время (без часового пояса) в формат iso_days/0.

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

naive_datetime_to_string(
  year(),
  month(),
  day(),
  hour(),
  minute(),
  second(),
  microsecond()
) :: String.t()

Преобразует дату и время (без часового пояса) в строку в соответствии с календарём.

quarter_of_year(year, month, day)

quarter_of_year(year(), month(), day()) :: non_neg_integer()

Вычисляет квартал года из заданного year, month, и day.

time_from_day_fraction(day_fraction)

time_from_day_fraction(day_fraction()) ::
  {hour(), minute(), second(), microsecond()}

Преобразует day_fraction/0 в формат времени календаря.

time_to_day_fraction(hour, minute, second, microsecond)

time_to_day_fraction(hour(), minute(), second(), microsecond()) ::
  day_fraction()

Преобразует заданное время в формат day_fraction/0.

time_to_string(hour, minute, second, microsecond)

time_to_string(hour(), minute(), second(), microsecond()) :: String.t()

Преобразует время в строку в соответствии с календарём.

valid_date?(year, month, day)

valid_date?(year(), month(), day()) :: boolean()

Должен возвращать true, если заданная дата описывает корректную дату в календаре.

valid_time?(hour, minute, second, microsecond)

valid_time?(hour(), minute(), second(), microsecond()) :: boolean()

Должен возвращать true, если заданное время описывает корректное время в календаре.

year_of_era(year)

year_of_era(year()) :: {year(), era()}

Вычисляет год и эру из заданного year.