timex v3.2.0 API Reference
Modules
Represents a DateTime which is ambiguous due to timezone rules
Represents a choice of two possible timezone periods for a given point in time
This module contains functions for working with dates in the Julian calendar
This protocol is used for comparing and diffing different date/time representations
This module provides a friendly API for working with Erlang
timestamps, i.e. {megasecs, secs, microsecs}
. In addition,
it provides an easy way to wrap the measurement of function
execution time (via measure
)
This module defines the behaviour for custom DateTime formatters
Date formatting language used by default by the formatting functions in Timex
Relative time, based on Moment.js
Date formatting language defined by the strftime
function from the Standard
C Library
This module defines the behaviour for custom Time formatters
Handles formatting Duration values as ISO 8601 durations as described below
Handles formatting timestamp values as human readable strings.
For formatting timestamps as points in time rather than intervals,
use Timex.format
This module is used for creating and manipulating DateTime intervals
This is the base plugin behavior for all Timex date/time string parsers
Defines the API for a custom tokenizer which can extend Timex’s datetime parsing facilities
Implements the parser for the default DateTime format strings
Implements the parser for strftime-style datetime format strings
This module is responsible for parsing input strings into Duration structs. The actual parsing is delegated to specific parser modules, but this module provides a unified API for all of them
This module parses ISO-8601 duration strings into Duration structs
Parses POSIX-style timezones
This module is responsible for parsing binary zoneinfo files, such as those found in /usr/local/zoneinfo
Represents the data retreived from a binary tzfile. For details on the tzfile format, see
This protocol defines the API for functions which take a Date
,
NaiveDateTime
, or DateTime
as input
This module provides helper functions for working with Times
This module is used for looking up the timezone information for
a given point in time, in the desired zone. Timezones are dependent
not only on locale, but the date and time for which you are querying.
For instance, the timezone offset from UTC for Europe/Moscow
is different
for March 3rd of 2015, than it was in 2013. These differences are important,
and as such, all functions in this module are date/time sensitive, and where
omitted, the current date/time are assumed
This module is responsible for determining the timezone configuration of the local machine. It determines this from a number of sources, depending on platform, but the order of precedence is as follows
All relevant timezone information for a given period, i.e. Europe/Moscow on March 3rd, 2013
Exceptions
Used for errors encountered during string formatting
Thrown when an error occurs with formatting an Interval
Used for errors encountered during parsing