View Source Tempus.Slot (Tempus v0.7.0)

Declares a timeslot and exports functions to check whether the given date and/or datetime is covered by this slot or not.

This module probably should not be called directly.

Link to this section Summary

Types

The origin used in comparisons and calculations

t()

A timeslot to be used in Tempus

Functions

Compares two slot structs.

Checks whether to Slot covers the data/datetime passed as a second argument.

Returns true if two slots are disjoined, false otherwise.

Calculates the duration of a slot in units given as a second parameter (default: :second.)

Intersects slots to the minimal covered timeslice.

Joins slots to the maximal covered timeslice.

Returns true if two slots are neighbours, false otherwise.

Compares two slot structs. The same as compare/2, but returns :joint if the slots are overlapped.

Checks whether the Slot is valid (to > from) or not.

Wraps the argument into a slot. For DateTime it’d be a single microsecond. For a Date, it would be the whole day, starting at 00:00:00.000000 and

Link to this section Types

@type origin() :: t() | Date.t() | DateTime.t() | Time.t() | nil

The origin used in comparisons and calculations

@type t() :: %Tempus.Slot{from: nil | DateTime.t(), to: nil | DateTime.t()}

A timeslot to be used in Tempus

Link to this section Functions

Link to this function

compare(s1, s2, strict \\ false)

View Source
@spec compare(s1 :: t(), s2 :: t(), strict :: boolean()) :: :lt | :gt | :eq | :joint

Compares two slot structs.

Returns :gt if first slot is strictly later than the second and :lt for vice versa. NB :eq is returned not only if slots are equal, but also when they are overlapped.

Might be used in Enum.sort/2.

Link to this function

cover?(slot, dt, strict? \\ false)

View Source
@spec cover?(slot :: t(), dt :: origin(), strict? :: boolean()) :: boolean()

Checks whether to Slot covers the data/datetime passed as a second argument.

examples

Examples

iex> dt_between = ~U|2015-09-30 01:00:00Z|
...> dt_from = ~U|2015-09-30 00:00:00Z|
...> dt_to = ~U|2015-10-01 01:00:00Z|
...> d_from = Date.from_iso8601!("2015-09-30")
...> d_to = Date.from_iso8601!("2015-10-01")
iex> slot = %Tempus.Slot{from: dt_from, to: dt_to}
iex> Tempus.Slot.cover?(slot, dt_between)
true
iex> Tempus.Slot.cover?(slot, dt_to)
true
iex> Tempus.Slot.cover?(slot, dt_to, true)
false
iex> Tempus.Slot.cover?(slot, d_from)
true
iex> Tempus.Slot.cover?(slot, d_from, true)
false
iex> Tempus.Slot.cover?(slot, d_to)
false
@spec disjoint?(s1 :: origin(), s2 :: origin()) :: boolean()

Returns true if two slots are disjoined, false otherwise.

examples

Examples

iex> slot = %Tempus.Slot{from: ~U|2015-09-01 00:00:00Z|, to: ~U|2015-10-01 00:00:00Z|}
iex> inner = %Tempus.Slot{from: ~U|2015-09-01 00:00:00Z|, to: ~U|2015-09-01 01:00:00Z|}
iex> Tempus.Slot.disjoint?(slot, inner)
false
iex> inner = %Tempus.Slot{from: ~U|2015-09-01 00:00:00Z|, to: ~U|2015-10-01 01:00:00Z|}
iex> Tempus.Slot.disjoint?(slot, inner)
false
iex> outer = %Tempus.Slot{from: ~U|2015-10-01 00:00:01Z|, to: ~U|2015-10-01 01:00:00Z|}
iex> Tempus.Slot.disjoint?(slot, outer)
true
Link to this function

duration(slot, unit \\ :second)

View Source
@spec duration(slot :: t(), unit :: System.time_unit()) ::
  non_neg_integer() | :infinity

Calculates the duration of a slot in units given as a second parameter (default: :second.)

example

Example

iex> ~D|2020-09-03| |> Tempus.Slot.wrap() |> Tempus.Slot.duration()
86400
@spec intersect(slots :: Enum.t()) :: t() | nil

Intersects slots to the minimal covered timeslice.

example

Example

iex> Tempus.Slot.intersect([Tempus.Slot.wrap(~D|2020-09-30|),
...>   %Tempus.Slot{from: ~U|2020-09-30 23:00:00Z|, to: ~U|2020-10-02 00:00:00Z|}])
#Slot<[from: ~U[2020-09-30 23:00:00Z], to: ~U[2020-09-30 23:59:59.999999Z]]>
@spec join(slots :: Enum.t()) :: t()

Joins slots to the maximal covered timeslice.

example

Example

iex> Tempus.Slot.join([Tempus.Slot.wrap(~D|2020-09-30|), Tempus.Slot.wrap(~D|2020-10-02|)])
#Slot<[from: ~U[2020-09-30 00:00:00.000000Z], to: ~U[2020-10-02 23:59:59.999999Z]]>

iex> Tempus.Slot.join([~D|2020-09-30|, ~D|2020-10-02|])
#Slot<[from: ~U[2020-09-30 00:00:00.000000Z], to: ~U[2020-10-02 23:59:59.999999Z]]>
@spec neighbour?(s1 :: origin(), s2 :: origin()) :: boolean()

Returns true if two slots are neighbours, false otherwise.

examples

Examples

iex> slot = %Tempus.Slot{from: ~U|2015-09-01 00:00:00Z|, to: ~U|2015-10-01 23:59:59Z|}
iex> Tempus.Slot.neighbour?(slot, Tempus.Slot.wrap(~D|2015-10-02|))
true
iex> Tempus.Slot.neighbour?(slot, Tempus.Slot.wrap(~D|2015-08-31|))
true
iex> Tempus.Slot.neighbour?(slot, Tempus.Slot.wrap(~D|2015-10-01|))
false
iex> Tempus.Slot.neighbour?(slot, Tempus.Slot.wrap(~D|2015-10-03|))
false
Link to this function

shift_tz(slot, tz \\ "Etc/UTC", tz_db \\ Calendar.get_time_zone_database())

View Source
@spec shift_tz(
  slot :: t(),
  tz :: Calendar.time_zone(),
  tz_db :: Calendar.time_zone_database()
) :: t()

Shifts both from and to values to UTC zone.

examples

Examples

slot = %Tempus.Slot{
   from: DateTime.from_naive!(~N|2018-01-05 21:00:00|, "America/New_York"),
   to: DateTime.from_naive!(~N|2018-01-08 08:59:59|, "Australia/Sydney")
}
#⇒ #Slot<[from: ~U[2018-01-06 02:00:00Z], to: ~U[2018-01-07 21:59:59Z]]>
@spec strict_compare(s1 :: t(), s2 :: t()) :: :eq | :lt | :gt | :joint

Compares two slot structs. The same as compare/2, but returns :joint if the slots are overlapped.

@spec valid?(slot :: t()) :: boolean()

Checks whether the Slot is valid (to > from) or not.

examples

Examples

iex> slot = %Tempus.Slot{from: ~U|2015-09-30 00:00:00Z|, to: ~U|2015-10-01 01:00:00Z|}
iex> Tempus.Slot.valid?(slot)
true
iex> Tempus.Slot.valid?(%Tempus.Slot{from: slot.to, to: slot.from})
false
Link to this function

wrap(moment \\ nil, origin \\ DateTime.utc_now())

View Source
@spec wrap(origin(), DateTime.t()) :: t()

Wraps the argument into a slot. For DateTime it’d be a single microsecond. For a Date, it would be the whole day, starting at 00:00:00.000000 and

ending at `23:59:59:999999`.

examples

Examples

iex> Tempus.Slot.wrap(~D|2020-08-06|)
#Slot<[from: ~U[2020-08-06 00:00:00.000000Z], to: ~U[2020-08-06 23:59:59.999999Z]]>