timex v0.15.0

Modules summary

Timex

Timex

Timex.Date

Module for working with dates

Timex.DateFormat

Date formatting and parsing

Timex.DateFormat.Formats

This module defines all known (by timex) common date/time formats, in macro form

Timex.DateFormat.Formatters.DefaultFormatter

Date formatting language used by default by the DateFormat module

Timex.DateFormat.Formatters.Formatter
Timex.DateFormat.Formatters.StrftimeFormatter

Date formatting language defined by the strftime function from the Standard C Library

Timex.DateTime
Timex.Parsers.DateFormat.DefaultParser

This module is responsible for parsing date strings using the default timex formatting syntax

Timex.Parsers.DateFormat.Directive

This module defines parsing directives for all date/time tokens timex knows about. It is composed of a Directive struct, containing the rules for parsing a given token, and a get/1 function, which fetches a directive for a given token value, i.e. :year4

Timex.Parsers.DateFormat.Parser

This is the base plugin behavior for all Timex date/time string parsers

Timex.Parsers.DateFormat.ParserState
Timex.Parsers.DateFormat.StrftimeParser

This module is responsible for parsing date strings using the strftime formatting syntax

Timex.Parsers.DateFormat.Tokenizers.Default

Responsible for tokenizing date/time format strings which use the Default formatter

Timex.Parsers.DateFormat.Tokenizers.Strftime

Responsible for tokenizing date/time format strings which use the strftime formatter

Timex.Parsers.ZoneInfo

This module is responsible for parsing binary zoneinfo files, such as those found in /usr/local/zoneinfo

Timex.Parsers.ZoneInfo.Zone

Represents the data retreived from a binary tzfile. For details on the tzfile format, see:

Timex.Time

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)

Timex.TimeFormatter

Handles formatting timestamp values as human readable strings. For formatting timestamps as points in time rather than intervals, use DateFormat

Timex.Timezone

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

Timex.Timezone.Database

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

Timex.Timezone.Local

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:

Timex.TimezoneInfo

All relevant timezone information for a given period, i.e. Europe/Moscow on March 3rd, 2013

Exceptions summary

Timex.DateFormat.FormatError

Used for errors encountered during date formatting

Timex.Parsers.ParseError

Used for errors encountered during date parsing

Protocols summary

Timex.Date.Convert