timex v2.1.0 API Reference
Modules
Timex
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 that are common across more than a single calendar
This module contains functions specific to the Gregorian calendar, many things are still in other modules, but as multi-calendar support is added, those things specific to Gregorian will be moved here
This module contains functions for working with dates in the Julian calendar
This module represents all functions specific to creating/manipulating/comparing Dates (year/month/day)
A type which represents a date and time with timezone information (optional, UTC will be assumed for date/times with no timezone information provided)
This module defines the behaviour for custom DateTime formatters
Date formatting language used by default by the DateFormat
module
Date formatting language defined by the strftime
function from the Standard
C Library
This module defines the behaviour for custom Time formatters
Handles formatting timestamp 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
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 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 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 not really intended for use outside of Timex, but it provides a way to map Olson timezone names to Windows timezone names, and vice versa
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
Protocols
This protocol is used for comparing and diffing different date/time representations
This protocol is used to convert between various common datetime formats