antikythera

v0.3.0

antikythera v0.3.0 Antikythera.Time View Source

Data structure to represent date and time in milli-seconds resolution.

Note that all values of Antikythera.Time.t are in UTC.

Poison.Encoder protocol is implemented for Antikythera.Time.t, so that values of this type can be directly converted to Antikythera.IsoTimestamp.t on Poison.encode/1.

iex> Poison.encode(%{time: {Antikythera.Time, {2017, 1, 1}, {0, 0, 0}, 0}})
{:ok, "{"time":"2017-01-01T00:00:00.000+00:00"}"}

See also new/1.

Link to this section Summary

Types

t()

Functions

diff_milliseconds(t1, t2)
from_epoch_milliseconds(milliseconds)
from_gregorian_milliseconds(milliseconds)
from_http_date(s)

Parses HTTP-date formats into Antikythera.Time.t.

from_http_date!(arg0)
from_iso_basic(s)
from_iso_basic!(arg0)
from_iso_timestamp(s)
from_iso_timestamp!(arg0)
new(s)

Convert timestamps into Antikythera.Time.t, leveraging recursive_new? option of Croma.Struct.

now()
shift_days(t, days)
shift_hours(t, hours)
shift_milliseconds(t, milliseconds)
shift_minutes(t, minutes)
shift_seconds(t, seconds)
to_epoch_milliseconds(t)
to_gregorian_milliseconds(arg0)
to_http_date(arg0)

Returns date/time in IMF-fixdate format.

to_iso_basic(arg0)
to_iso_timestamp(arg0)
truncate_to_day(arg0)
truncate_to_hour(arg0)
truncate_to_minute(arg0)
truncate_to_second(arg0)
valid?(v)

Link to this section Types

Link to this type

t()

View Source 
t() :: {Antikythera.Time, :calendar.date(), :calendar.time(), milliseconds()}

Link to this section Functions

Link to this function

diff_milliseconds(t1, t2)

View Source 
diff_milliseconds(t(), t()) :: integer()
Link to this function

from_epoch_milliseconds(milliseconds)

View Source 
from_epoch_milliseconds(Antikythera.MilliSecondsInGregorian.t()) :: t()
Link to this function

from_gregorian_milliseconds(milliseconds)

View Source 
from_gregorian_milliseconds(integer()) :: t()
Link to this function

from_http_date(s)

View Source 
from_http_date(String.t()) :: Croma.Result.t(t())

Parses HTTP-date formats into Antikythera.Time.t.

Supports IMF-fixdate format, RFC 850 format and ANSI C's asctime() format for compatibility.

Note: An HTTP-date value must represents time in UTC(GMT). Thus timezone string in the end must always be 'GMT'. Any other timezone string (such as 'JST') will actually be ignored and parsed as GMT.

https://tools.ietf.org/html/rfc7231#section-7.1.1.1

Link to this function

from_http_date!(arg0)

View Source 
from_http_date!(String.t()) :: t()
Link to this function

from_iso_basic(s)

View Source 
from_iso_basic(String.t()) :: Croma.Result.t(t())
Link to this function

from_iso_basic!(arg0)

View Source 
from_iso_basic!(String.t()) :: t()
Link to this function

from_iso_timestamp(s)

View Source 
from_iso_timestamp(String.t()) :: Croma.Result.t(t())
Link to this function

from_iso_timestamp!(arg0)

View Source 
from_iso_timestamp!(String.t()) :: t()
Link to this function

new(s)

View Source 
new(Antikythera.IsoTimestamp.t()) :: Croma.Result.t(t())

Convert timestamps into Antikythera.Time.t, leveraging recursive_new? option of Croma.Struct.

Only Antikythera.IsoTimestamp.t can be converted.

Link to this function

now()

View Source 
now() :: t()
Link to this function

shift_days(t, days)

View Source 
shift_days(t(), integer()) :: t()
Link to this function

shift_hours(t, hours)

View Source 
shift_hours(t(), integer()) :: t()
Link to this function

shift_milliseconds(t, milliseconds)

View Source 
shift_milliseconds(t(), integer()) :: t()
Link to this function

shift_minutes(t, minutes)

View Source 
shift_minutes(t(), integer()) :: t()
Link to this function

shift_seconds(t, seconds)

View Source 
shift_seconds(t(), integer()) :: t()
Link to this function

to_epoch_milliseconds(t)

View Source 
to_epoch_milliseconds(t()) :: integer()
Link to this function

to_gregorian_milliseconds(arg0)

View Source 
to_gregorian_milliseconds(t()) :: integer()
Link to this function

to_http_date(arg0)

View Source 
to_http_date(t()) :: Antikythera.ImfFixdate.t()

Returns date/time in IMF-fixdate format.

The format is subset of Internet Message Format (RFC5322, formarly RFC822, RFC1123). Defined as 'preferred' format in RFC7231 and modern web servers or clients should send in this format.

https://tools.ietf.org/html/rfc7231#section-7.1.1.1

Link to this function

to_iso_basic(arg0)

View Source 
to_iso_basic(t()) :: Antikythera.IsoTimestamp.Basic.t()
Link to this function

to_iso_timestamp(arg0)

View Source 
to_iso_timestamp(t()) :: Antikythera.IsoTimestamp.t()
Link to this function

truncate_to_day(arg0)

View Source 
truncate_to_day(t()) :: t()
Link to this function

truncate_to_hour(arg0)

View Source 
truncate_to_hour(t()) :: t()
Link to this function

truncate_to_minute(arg0)

View Source 
truncate_to_minute(t()) :: t()
Link to this function

truncate_to_second(arg0)

View Source 
truncate_to_second(t()) :: t()
Link to this function

valid?(v)

View Source 
valid?(term()) :: boolean()