Returns true if date1 occurs after date2.

Examples

iex> Tox.Date.after?(~D[2020-06-14], ~D[2020-06-22])
false

iex> Tox.Date.after?(~D[2020-07-14], ~D[2020-06-22])
true

iex> Tox.Date.after?(~D[2020-01-01], ~D[2020-01-01])
false

iex> Tox.Date.after?(
...>   Date.convert!(~D[2000-01-22], Cldr.Calendar.Coptic),
...>   Date.convert!(~D[2000-01-01], Cldr.Calendar.Coptic)
...> )
true

Returns true if date1 occurs after date2 or both dates are equal.

Examples

iex> Tox.Date.after_or_equal?(~D[2020-06-14], ~D[2020-06-22])
false

iex> Tox.Date.after_or_equal?(~D[2020-07-14], ~D[2020-06-22])
true

iex> Tox.Date.after_or_equal?(~D[2020-01-01], ~D[2020-01-01])
true

iex> Tox.Date.after_or_equal?(
...>   Date.convert!(~D[2000-01-22], Cldr.Calendar.Ethiopic),
...>   Date.convert!(~D[2000-01-01], Cldr.Calendar.Ethiopic)
...> )
true

Returns true if date1 occurs before date2.

Examples

iex> Tox.Date.before?(~D[2020-06-14], ~D[2020-06-22])
true

iex> Tox.Date.before?(~D[2020-07-14], ~D[2020-06-22])
false

iex> Tox.Date.before?(~D[2020-01-01], ~D[2020-01-01])
false

iex> Tox.Date.before?(
...>   Date.convert!(~D[2000-01-22], Cldr.Calendar.Ethiopic),
...>   Date.convert!(~D[2000-06-01], Cldr.Calendar.Ethiopic)
...> )
true

Returns true if date1 occurs before date2 or both dates are equal.

Examples

iex> Tox.Date.before_or_equal?(~D[2020-06-14], ~D[2020-06-22])
true

iex> Tox.Date.before_or_equal?(~D[2020-07-14], ~D[2020-06-22])
false

iex> Tox.Date.before_or_equal?(~D[2020-01-01], ~D[2020-01-01])
true

iex> Tox.Date.before_or_equal?(
...>   Date.convert!(~D[2000-01-22], Cldr.Calendar.Ethiopic),
...>   Date.convert!(~D[2000-06-01], Cldr.Calendar.Ethiopic)
...> )
true

Specs

beginning_of_month(Calendar.date()) :: Calendar.date()

Returns a date representing the start of the month.

Examples

iex> Tox.Date.beginning_of_month(~D[2020-11-11])
~D[2020-11-01]

Specs

beginning_of_week(Calendar.date()) :: Calendar.date()

Returns a date representing the start of the week.

Examples

iex> Tox.Date.beginning_of_week(~D[2020-11-13])
~D[2020-11-09]

Specs

beginning_of_year(Calendar.date()) :: Calendar.date()

Returns a date representing the start of the year.

Examples

iex> Tox.Date.beginning_of_year(~D[2020-11-11])
~D[2020-01-01]

Specs

between?(Calendar.date(), Calendar.date(), Calendar.date(), Tox.boundaries()) ::
  boolean()

Returns a boolean indicating whether date occurs between from and to. The optional boundaries specifies whether from and to are included or not. The possible value for boundaries are:

• :open: from and to are excluded
• :closed: from and to are included
• :left_open: from is excluded and to is included
• :right_open: from is included and to is excluded

Examples

iex> from = ~D[2020-02-01]
iex> to   = ~D[2020-03-01]
iex> Tox.Date.between?(~D[2020-01-01], from, to)
false
iex> Tox.Date.between?(~D[2020-02-05], from, to)
true
iex> Tox.Date.between?(~D[2020-03-05], from, to)
false
iex> Tox.Date.between?(~D[2020-02-01], from, to)
true
iex> Tox.Date.between?(~D[2020-03-01], from, to)
false
iex> Tox.Date.between?(~D[2020-02-01], from, to, :open)
false
iex> Tox.Date.between?(~D[2020-03-01], from, to, :open)
false
iex> Tox.Date.between?(~D[2020-02-01], from, to, :closed)
true
iex> Tox.Date.between?(~D[2020-03-01], from, to, :closed)
true
iex> Tox.Date.between?(~D[2020-02-01], from, to, :left_open)
false
iex> Tox.Date.between?(~D[2020-03-01], from, to, :left_open)
true
iex> Tox.Date.between?(~D[2000-01-01], to, from)
** (ArgumentError) from is equal or greater as to

Specs

end_of_month(Calendar.date()) :: Calendar.date()

Returns a date representing the end of the month.

Examples

iex> Tox.Date.end_of_month(~D[2020-11-11])
~D[2020-11-30]

iex> ~D[2020-12-31]
...> |> Date.convert!(Cldr.Calendar.Coptic)
...> |> Tox.Date.shift(day: 1)
...> |> Tox.Date.end_of_month()
%Date{year: 1737, month: 4, day: 30, calendar: Cldr.Calendar.Coptic}

Specs

end_of_week(Calendar.date()) :: Calendar.date()

Returns a date representing the end of the week.

Examples

iex> Tox.Date.end_of_week(~D[2020-11-11])
~D[2020-11-15]

iex> ~D[2020-11-11]
...> |> Date.convert!(Cldr.Calendar.Ethiopic)
...> |> Tox.Date.end_of_week()
%Date{year: 2013, month: 3, day: 6, calendar: Cldr.Calendar.Ethiopic}

Specs

end_of_year(Calendar.date()) :: Calendar.date()

Returns a date representing the end of the year. If the date cannot be determined, {:error, reason} is returned.

Examples

iex> Tox.Date.end_of_year(~D[2020-11-11])
~D[2020-12-31]

iex> ~D[2020-11-11]
iex> |> Date.convert!(Cldr.Calendar.Coptic)
iex> |> Tox.Date.end_of_year()
%Date{year: 1737, month: 13, day: 5, calendar: Cldr.Calendar.Coptic}

Returns true if both datets are equal.

Examples

iex> Tox.Date.equal?(~D[2020-07-14], ~D[2020-06-22])
false

iex> Tox.Date.equal?(~D[2020-01-01], ~D[2020-01-01])
true

iex> ethiopic = Date.convert!(~D[2000-01-01], Cldr.Calendar.Ethiopic)
%Date{year: 1992, month: 4, day: 22, calendar: Cldr.Calendar.Ethiopic}
iex> coptic = Date.convert!(~D[2000-01-01], Cldr.Calendar.Coptic)
%Date{year: 1716, month: 4, day: 22, calendar: Cldr.Calendar.Coptic}
iex> Tox.Date.equal?(ethiopic, coptic)
true

Specs

shift(Calendar.date(), [Tox.duration()]) :: Date.t()

Shifts the date by the given duration.

The durations is a keyword list of one or more durations of the type Tox.duration e.g. [year: 1, month: 5, day: 500]. All values will be shifted from the largest to the smallest unit.

Examples

iex> date = ~D[1980-11-01]
iex> Tox.Date.shift(date, year: 2)
~D[1982-11-01]
iex> Tox.Date.shift(date, year: -2, month: 1, day: 40)
~D[1979-01-10]
# time units will be ignored
iex> Tox.Date.shift(date, hour: 100, minute: 10, second: 10)
~D[1980-11-01]

Adding a month at the end of the month can update the day too.

iex> Tox.Date.shift(~D[2000-01-31], month: 1)
~D[2000-02-29]

For that reason it is important to know that all values will be shifted from the largest to the smallest unit.

iex> date = ~D[2000-01-30]
iex> Tox.Date.shift(date, month: 1, day: 1)
~D[2000-03-01]
iex> date |> Tox.Date.shift(month: 1) |> Tox.Date.shift(day: 1)
~D[2000-03-01]
iex> date |> Tox.Date.shift(day: 1) |> Tox.Date.shift(month: 1)
~D[2000-02-29]

Using shift/2 with a different calendar.

iex> ~D[2000-12-30]
...> |> Date.convert!(Cldr.Calendar.Coptic)
...> |> Tox.Date.shift(day: 3)
%Date{year: 1717, month: 4, day: 24, calendar: Cldr.Calendar.Coptic}

Specs

week(Calendar.date()) :: {Calendar.year(), non_neg_integer()}

Returns an {year, week} representing the ISO week number for the specified date.

This function is just defined for dates with Calendar.ISO.

Example

iex> Tox.Date.week(~D[2017-01-01])
{2016, 52}
iex> Tox.Date.week(~D[2020-01-01])
{2020, 1}
iex> Tox.Date.week(~D[2019-12-31])
{2020, 1}
iex> ~D[2020-06-04]
...> |> Date.convert(Cldr.Calendar.Ethiopic)
...> |> Tox.Date.week()
** (FunctionClauseError) no function clause matching in Tox.Date.week/1